[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] | Reference for unit 'Forms' (#lcl)

# TCustomForm.GetDefaultDockCaption

Default caption displayed when the form is docked.

## Declaration

Source position: forms.pp line 684

`protected function TCustomForm.GetDefaultDockCaption: string; override;`

## Function result

Default caption displayed when the form is docked.

## Description

GetDefaultDockCaption is an overridden String function used to get the default caption displayed when the form is docked. GetDefaultDockCaption returns the value in the Caption property.

Called from the GetDockCaption method in an ancestor class. The value is passed as an argument to the OnGetDockCaption event handler.

## See also

TCustomForm.Caption |  | The text displayed in the title bar for the form.
TWinControl.GetDockCaption |  | Returns the docking caption for the specified control.
TWinControl.OnGetDockCaption |  | This handler can provide a special DockCaption, different than the Caption default.