TcxCustomImageProperties.Caption Property

Specifies the caption displayed when the image editor has no loaded image.

Declaration

property Caption: string read; write;

Property Value

Type	Description
string	The caption for the empty image editor.

Remarks

Use the Caption property to display text in the image editor when it is empty. For example, you can prompt a user to perform an action:

Image Editor Caption Font Settings

You can use the image editor’s Style.Font and Style.TextColor properties to customize font settings applied to the text string assigned to the Caption property. In addition, you can use the same font settings accessible through the following properties to customize font appearance in corresponding editor states:

StyleDisabled

Defines style settings applied to the editor when it is disabled.

StyleFocused

Defines style settings applied to the editor when it has focus.

StyleHot

Defines style settings applied to the editor when it is hot-tracked.

StyleReadOnly

Defines style settings applied to the read-only editor state.

Tip

To apply the same style settings to multiple editors, use a TcxEditStyleController component. If you need to apply the same style settings to all editors in your application, you can use a TcxDefaultEditStyleController component.

Default Value

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

The default Caption property value indicates that the empty image editor displays no caption.