Skip to main content

TcxCustomEditButton.Caption Property

Specifies the editor button caption.

Declaration

property Caption: TCaption read; write;

Property Value

Type Description
TCaption

The editor button caption.

Remarks

Use the Caption property to assign a caption to the editor button. The button displays the Caption property value only if the Kind property is set to bkText.

VCL Editors Library: An Editor Button Displays Caption Text

If the button width is not sufficient to fit the caption in full, the button crops text and displays an ellipsis at the end of the caption.

VCL Editors Library: An Editor Button Crops Caption Text

If the button width exceeds the current caption text length, you can use the ContentAlignment property to position text within the button.

VCL Editors Library: Left-Aligned Caption Text

Caption and UIA Node Name

The editor button uses the Caption property value as the corresponding UI Automation node name if the Automation.Name property is unspecified.

Refer to the Automation property description for detailed information on UI Automation functionality for embedded editor buttons.

Default Value

The Caption property’s default value is an empty string.

See Also