TCustomForm.GetDefaultDockCaption function

Declaration

function 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

• Caption
• TWinControl.GetDockCaption
• TWinControl.OnGetDockCaption