Show: Delphi C++
Display Preferences

Vcl.Controls.TWinControl.GetSiteInfo

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

procedure GetSiteInfo(Client: TControl; var InfluenceRect: TRect;  MousePos: TPoint; var CanDock: Boolean); dynamic;

C++

DYNAMIC void __fastcall GetSiteInfo(TControl* Client, System::Types::TRect &InfluenceRect, const System::Types::TPoint &MousePos, bool &CanDock);

Properties

Type Visibility Source Unit Parent
procedure
function
protected
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls TWinControl

Description

Generates an OnGetSiteInfo event.

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.

See Also

Personal tools
In Other Languages
Previous Versions
Assistance