Vcl.ExtCtrls.TCustomControlBar.GetSiteInfo
Delphi
procedure GetSiteInfo(Client: TControl; var InfluenceRect: TRect; MousePos: TPoint; var CanDock: Boolean); override;
C++
DYNAMIC void __fastcall GetSiteInfo(Vcl::Controls::TControl* Client, System::Types::TRect &InfluenceRect, const System::Types::TPoint &MousePos, bool &CanDock);
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
procedure function |
protected | Vcl.ExtCtrls.pas Vcl.ExtCtrls.hpp |
Vcl.ExtCtrls | TCustomControlBar |
Description
Returns the control bar’s dock site information.
GetSiteInfo generates an OnGetSiteInfo event to allow an application influence how controls are docked to the control bar. On return from the event handler, GetSiteInfo sets the CanDock parameter to False if the control is not floating. This prevents controls that have been docked to other dock sites from being moved to the control bar. Client is the control that is a potential dock client. InfluenceRect code returns the dimensions where the client will be docked. MousePos is the position of the mouse pointer. CanDock returns whether the client is permitted to dock in the control bar.