Vcl.ComCtrls.TPageControl.GetSiteInfo

From RAD Studio API Documentation
Jump to: navigation, search

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.ComCtrls.pas
Vcl.ComCtrls.hpp
Vcl.ComCtrls TPageControl

Description

Returns the page control's docking information.

Call GetSiteInfo to determine the docking region of the page control and whether a dragged window can be docked.

Client is a potential docking client.

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

MousePos is the current mouse position.

CanDock indicates whether the client can be docked in the page control.

GetSiteInfo initializes CanDock to true if Client is not already docked in the page control. It then inflates the influence rectangle by 10 pixels and generates an OnOnGetSiteInfo event.

See Also