TdxFormattedLabel Class

An unbound formatted label control.

Declaration

TdxFormattedLabel = class(
    TdxCustomFormattedLabel
)

Remarks

A formatted label is a simple control designed to display a short static description with support for BBCode-inspired markup tags.

Main API Members

The list below outlines key members of the TdxFormattedLabel class. These members allow you to configure the unbound formatted label.

Appearance Settings

Caption

Specifies the label’s caption. You can use all supported BBCode-inspired markup tags in this action in any combination.

Style | StyleDisabled | StyleFocused | StyleHot | StyleReadOnly

Allow you to define individual appearance settings for different editor states.

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.

Styles

Provides access to individual styles applied to the editor in different states.

Transparent

Specifies if the editor is transparent in GDI render mode.

Editor Settings and Repository Items

ActiveProperties

Provides access to the current formatted label settings regardless of their source. This property set does not allow you to customize editor settings.

GetPropertiesClass

Returns the actual editor settings type.

Properties

Allows you to customize formatted label settings directly if the editor does not have an assigned repository item.

RepositoryItem

Specifies a repository item as an external source of editor settings. A repository item has priority over other editor settings.

General-Purpose API Members

AutoSize

Specifies if the editor automatically adjusts its size to fit content.

Enabled

Specifies if the editor is enabled.

ShowHint

Specifies if the standalone editor can display hints. To enable hints for an in-place editor in a container control, set its OptionsBehavior.CellHints^[1] property to True.

Width | Height

Allow you to explicitly define editor dimensions.

Inheritance

Show 13 items

TObject

TPersistent

TComponent

TControl

TWinControl

TCustomControl

TcxCustomControl

TcxControl

TcxContainer

TcxCustomEditContainer

TcxCustomEdit

TdxCustomFormattedLabel

TdxFormattedLabel

Footnotes

1. Set the following behavior properties to True or False to enable or disable in-place editor hints in corresponding container controls:

   • A Data Grid Table View’s OptionsBehavior.CellHints property.
   • A Tree List control’s OptionsBehavior.CellHints property.
   • A Vertical Grid control’s OptionsBehavior.CellHints property.