Vcl.Controls.TGetSiteInfoEvent

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

TGetSiteInfoEvent = procedure(Sender: TObject; DockClient: TControl;
var InfluenceRect: TRect; MousePos: TPoint; var CanDock: Boolean) of object;

C++

typedef void __fastcall (__closure *TGetSiteInfoEvent)(System::TObject* Sender, TControl* DockClient, System::Types::TRect &InfluenceRect, const System::Types::TPoint &MousePos, bool &CanDock);

Properties

Type Visibility Source Unit Parent
type
typedef
public
Vcl.Controls.pas
Vcl.Controls.hpp
Vcl.Controls Vcl.Controls

Description

TGetSiteInfoEvent is the type of the OnGetSiteInfo event handler.

Sender is the dock site.

DockClient is the control being dragged.

InfluenceRect is the rectangle in which the mouse must be positioned for the dock site to accept a dragged control. By default, InfluenceRect is the area of the target control, expanded by 10 pixels on each side. This can be adjusted by the event handler.

MousePos is the position of the mouse pointer.

CanDock returns whether the dragged control can be docked to the dock site.

See Also