TdxCustomDockControl.CaptionButtons Property

Specifies which standard buttons are displayed inside the caption of the dock control.

Declaration

property CaptionButtons: TdxCaptionButtons read; write; default dxDockingDefaultCaptionButtons;

Property Value

Type	Default
TdxCaptionButtons	dxDockingDefaultCaptionButtons

Remarks

The table below lists all the available standard buttons, describes their purpose and the situations when they are visible.

Values	Description
cbMaximize	This button is only visible when panels are joined into a side container. If clicked, the corresponding panel is expanded so that client areas of neighboring panels are not displayed. The button’s appearance changes and clicking it again will restore the previous panel size. See the ActiveChildIndex property description for details on maximizing and restoring dock controls’ sizes.
cbHide	This button is only visible when panels are not on a float site. If clicked, the auto hide feature for the corresponding panel is enabled. The button changes its appearance and if clicked once again, disables the auto hide feature for the panel. See the AutoHide property description for details on the auto hide feature.
cbClose	This button hides the dock control when clicked. Note that if the tab container’s close button is clicked it can either close all panels within it or only the active one. This is controlled by the doTabContainerCanClose option. This option can be accessed via the Options property of the docking manager (or the docking controller). Also, refer to the doFreeOnClose and doUndockOnClose options for details on the functionality of the close button.

The table below shows these buttons painted in different styles. The current painting style is specified using the docking manager’s LookAndFeel property.

Button	Standard Paint Style	NET Paint Style	XP Paint Style
Maximize
Hide
Close

In addition to the standard caption buttons described above, you can provide buttons with custom functionality. Refer to the CustomCaptionButtons property description to learn more.

Note

Dock controls only display captions if their ShowCaption property is set to True.