TdxCustomFormattedLabel Class

The base class for unbound and data-aware formatted label controls.

Declaration

delphi

TdxCustomFormattedLabel = class(
    TcxCustomEdit,
    IcxHintableObject,
    IcxHintableObject2
)

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 TdxCustomFormattedLabel class. These members allow you to configure the formatted label.

Appearance Settings

CaptionSpecifies 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.

StylesProvides access to individual styles applied to the editor in different states.TransparentSpecifies if the editor is transparent in GDI render mode.

Editor Settings and Repository Items

ActivePropertiesProvides access to the current formatted label settings regardless of their source. This property set does not allow you to customize editor settings.GetPropertiesClassReturns the actual editor settings type.PropertiesAllows you to customize formatted label settings directly if the editor does not have an assigned repository item.RepositoryItemSpecifies a repository item as an external source of editor settings. A repository item has priority over other editor settings.

General-Purpose API Members

AutoSizeSpecifies if the editor automatically adjusts its size to fit content.EnabledSpecifies if the editor is enabled.ShowHintSpecifies 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 | HeightAllow you to explicitly define editor dimensions.

Terminal TdxCustomFormattedLabel Class Descendants

Do not use the TdxCustomFormattedLabel class directly. Use the following descendants instead:

TdxFormattedLabelAn unbound formatted label control.TdxDBFormattedLabelA data-aware formatted label control.

Implements

IcxHintableObject

Inheritance

Show 12 items

TObject TPersistent TComponent TControl TWinControl TCustomControl TcxCustomControl TcxControl TcxContainer TcxCustomEditContainer TcxCustomEdit TdxCustomFormattedLabel

Footnotes

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