TCustomForm.UpdateDockCaption procedure

Declaration

procedure UpdateDockCaption(Exclude: TControl); override

Arguments

Description

UpdateDockCaption is an overridden method used to get the combined Caption for all DockClients on the form. It does not call the inherited method.

Exclude contains a control which is omitted from the Caption values (when assigned). UpdateDockCaption iterates over the controls in DockClients to build the combined Caption for visible controls (other than the control in Exclude). Blank control captions are ignored. UTF8FixBroken is called to ensure that a given caption does not contain invalid UTF-8 characters. The caption for a TMemo control is truncated after 20 characters.

The Caption values for the controls are concatenated into a comma-delimited list of values which are assigned to the Caption property. An empty string is never assigned to the Caption property.

UpdateDockCaption is called when a new value is assigned to the Text property for a DockClient control with an assigned HostDockSite.

See also

• TWinControl.UpdateDockCaption