TcxDBButtonEdit Class

A data-aware single-line text editor with embedded buttons.

Declaration

TcxDBButtonEdit = class(
    TcxCustomButtonEdit
)

Remarks

A button editor is a single-line text editor with one or more embedded buttons and support for masked input.

VCL Editors Library: A Single-Line Text Editor with Embedded Buttons

Button Collection

A button editor maintains a collection of embedded buttons accessible through the Properties.Buttons property.

To associate editor buttons with specific functionality in your application, you can associate each button with an action object (a TBasicAction descendant instance) or handle the Properties.OnButtonClick event.

Main API Members

The list below outlines key members of the TcxDBButtonEdit class. These members allow you to configure button editors.

Appearance Settings

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.

Clear: Clears the editor.
CopyToClipboard | CutToClipboard | PasteFromClipboard: Allow you to perform clipboard operations.
EditValue: Specifies the edit value.
OnEditing: Allows you to prevent users from activating the editor.
ResetEditValue: Restores the previous edit value before the pending change is applied.
SelectAll: Selects editor content.
ValidateEdit: Validates the display value.

DataBinding: Allows you to bind the editor to data.
CanPostEditValue: Identifies if the data-aware editor can post its edit value to the bound data storage.
OnPostEditValue: Executes custom code when the editor posts its value to the bound data storage.
PostEditValue: Posts the edit value to the bound data storage.

Editor Settings and Repository Items

ActiveProperties: Provides access to the current editor 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 editor 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.
CanModify: Identifies if the editor is in read-only mode.
IsEditValidating | IsHiding | IsPosting: Allow you to identify the current operation in the editor.
ShowHint: Specifies if the standalone editor can display hints.
SupportsSpelling: Identifies if the editor supports the TdxSpellChecker component.
Width | Height: Allow you to explicitly define editor dimensions.

Repository Item Class

You can create a TcxEditRepositoryButtonItem component in an edit repository to define an unbound button editor, store button editor settings, and share them between multiple button editors.

Limitations

The data-aware button editor is designed as a standalone editor. You cannot use a TcxDBButtonEdit class instance as an in-place editor in container controls.