TdxCustomDockControl.DockState Property

Returns the current state of the dock control.

Declaration

property DockState: TdxDockingState read;

Property Value

Type
TdxDockingState

Remarks

Use the DockState property to determine the current state of the dock control. The following values can be returned by this property.

Value	Description
dsUndocked	The dock control has no parent dock control (it is not docked to any control). This can be achieved by calling the Undock method of the dock control. The is the state for dock controls created at runtime before they have been docked or made to float.
dsHidden	This value can be returned in two cases. First, if the dock control’s auto hide feature is enabled and it is hidden currently. Please refer to the AutoHide property description for details on enabling this feature. Second, when the dock control’s Visible property is set to False.
dsDocked	This value is returned if the dock control is currently visible and its immediate parent is not a float site.
dsFloating	This value is returned if the dock control is currently visible and its immediate parent is a float site. Note that a dock control may be on a float site but with its immediate parent being a tab container or a side container. In this case, the DockState property returns dsDocked.
dsDestroyed	Indicates that the control is no longer available. This value is returned by dock controls before they are actually destroyed. For instance, consider a tab container that is docked to a dock panel to form another tab container with other dock controls. In this case, the tab container is destroyed when docking and a new one is created. At the moment of docking, the tab container will not be actually destroyed, but its DockState property will return dsDestroyed indicating that the control is no longer available.