RAD Studio VCL Reference
ContentsIndex
PreviousUpNext
TCustomActionDockBar.GetSiteInfo Method

Generates an OnGetSiteInfo event

Pascal
procedure GetSiteInfo(Client: TControl; var InfluenceRect: TRect; MousePos: TPoint; var CanDock: Boolean); override;
C++
virtual __fastcall GetSiteInfo(TControl * Client, TRect InfluenceRect, TPoint MousePos, Boolean CanDock);

GetSiteInfo is called automatically during drag-and-dock operations to initialize a TDragDockObject with information about where a dragged object can be docked, if at all. 

Client is a potential docking client. 

InfluenceRect returns the area in which the client would be docked. 

MousePos is the current mouse position. 

CanDock returns whether the client can dock to the windowed control. 

As implemented in TWinControl, GetSiteInfo generates an influence rectangle equal to BoundsRect expanded by 10 pixels on every side, and then calls the OnGetSiteInfo event handler. 

 

Copyright(C) 2008 CodeGear(TM). All Rights Reserved.
What do you think about this topic? Send feedback!