TdxCustomDockControl.GetDockZoneAtPos(TdxCustomDockControl,TPoint) Method

Gets the dock zone at the specified point, provided that the control can be docked to it.

Declaration

delphi

function GetDockZoneAtPos(AControl: TdxCustomDockControl; APoint: TPoint): TdxZone; virtual;

Parameters

Name	Type
AControl	TdxCustomDockControl
APoint	TPoint

Returns

Type
TdxZone

Remarks

Dock controls store a list of dock zones in their DockZones property. The GetDockZoneAtPos method is used to obtain the dock zone residing under the specified point and capable of accepting the specified control.

The pt parameter specifies the search point and is specified in the dock control’s client coordinates. If a dock zone is found, the method checks whether the control specified by the AControl parameter can be docked to it. If so, the found zone is returned. Otherwise, the GetDockZoneAtPos method returns nil.

Normally, you will have no need to use this method in applications.