Skip to main content

TdxDockingManager.Options Property

Specifies a set of flags affecting the behavior of dock controls.

Declaration

property Options: TdxDockingOptions read; write; default dxDockingDefaultOptions;

Property Value

Type Default
TdxDockingOptions dxDockingDefaultOptions

Remarks

The Options property provides a set of flags affecting dock controls’ functionality. The following flags are available.

Flag

Description

doActivateAfterDocking

If enabled, dock controls become active after docking them to another dock control or to a site. Please refer to the descriptions of the docking controller’s ActiveDockControl property or the dock control’s Activate method for more information on active dock controls.

doDblClickDocking

If enabled, dock controls can be made floating and returned back to their previous position by double-clicking their captions. If a control is within a tab container, its tab must be double-clicked for this purpose.

doFloatingOnTop

If enabled, float forms are always displayed topmost. This implies that the fsStayOnTop flag is enabled in the FormStyle property of float forms. Otherwise, this flag is disabled and float forms may be hidden when other forms get focus.

doFreeOnClose

If enabled, dock controls are destroyed when closed (when their close button is clicked or the Close method is called). Otherwise, the control is either simply made invisible or undocked. This depends on the doUndockOnClose option setting.

doUndockOnClose

If enabled, dock controls are undocked when closed (when their close button is clicked or the Close method is called). Otherwise, they are made invisible or destroyed. This depends on the doFreeOnClose option setting.

Please refer to the UnDock method description for details on the undocking functionality.

doTabContainerHasCaption

If enabled, tab containers display captions if their ShowCaption property is set to True. Otherwise, tab container captions are not displayed regardless of the ShowCaption property value.

doTabContainerCanClose

If active, all children of a tab container are closed when clicking the close button within the container’s caption. Otherwise, only the control corresponding to the selected tab is closed.

doTabContainerCanAutoHide

If enabled, pressing the auto hide button within a tab container’s caption enables the auto hide feature for the tab container. Otherwise the auto hide feature is enabled for the tab container’s selected child only.

doSideContainerHasCaption

If enabled, vertical side containers display captions when within horizontal side containers. Horizontal side containers display captions when within vertical side containers. Note that side containers are allowed to be children of other side containers only when the doSideContainerCanInSideContainer option is enabled.

doSideContainerCanClose

If enabled, pressing the close button within a side container’s caption or calling the container’s Close method results in closing all the container’s children. Otherwise, the active child of the side container is closed. If there is no current active child, the first valid child control is closed.

doSideContainerCanAutoHide

If enabled, pressing the auto hide button within a side container’s caption or setting the container’s AutoHide property to True results in enabling the auto hide feature for the entire container. Otherwise, the auto hide feature is enabled for the current active child control. If there is no current active child, the feature is enabled for the first valid child control within the container.

doTabContainerCanInSideContainer

If enabled, tab containers can be children of side containers.

doSideContainerCanInTabContainer

If enabled, side containers can be children of tab containers.

doSideContainerCanInSideContainer

If enabled, side containers can be children of side containers.

doImmediatelyHideOnAutoHide

If enabled, dock controls are immediately hidden when the auto hide feature is enabled for them. Otherwise, they are hidden using the sliding animation effect and only when the mouse pointer leaves their area.

doHideAutoHideIfActive

If a dock control’s auto hide feature is enabled and the control is active, the doHideAutoHideIfActive option defines this control’s behavior when the mouse pointer leaves its area. If the option is active the control is automatically hidden in such cases. Otherwise, the control remains visible (the default behavior).

doRedrawOnResize

If active, all the child controls within a container are redrawn when the container is resized. This option is required to ensure that controls, which have transparent backgrounds, are painted correctly within a container. The doRedrawOnResize option has no effect within a container, which has a paint style other than the vsOffice11 or vsXP styles applied to it.

Note

When this option is active, resizing of a container might make the child controls flicker.

doFillDockingSelection

If active, a docking frame indicating a control’s potential position and size during drag operations is filled with the clHighlight system color.

doUseCaptionAreaForClientDocking

By default, to dock a control onto another with the client alignment, you need to drop a control into the target control’s center. This takes place when the doUseCaptionAreaForClientDocking option is disabled. If the option is active, you should drop controls to the captions of other controls to achieve the same result. This enables you to imitate the Visual Studio .NET IDE behavior.

See Also