Back to Devexpress

TcxDBButtonEdit Class

vcl-cxdbedit-1e5ce9f7.md

latest6.9 KB
Original Source

TcxDBButtonEdit Class

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

Declaration

delphi
TcxDBButtonEdit = class(
    TcxCustomButtonEdit
)

Remarks

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

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.

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

Content-Related APIs

ClearClears the editor.CopyToClipboard | CutToClipboard | PasteFromClipboardAllow you to perform clipboard operations.EditValueSpecifies the edit value.OnEditingAllows you to prevent users from activating the editor.ResetEditValueRestores the previous edit value before the pending change is applied.SelectAllSelects editor content.ValidateEditValidates the display value.

Data-Related APIs

DataBindingAllows you to bind the editor to data.CanPostEditValueIdentifies if the data-aware editor can post its edit value to the bound data storage.OnPostEditValueExecutes custom code when the editor posts its value to the bound data storage.PostEditValuePosts the edit value to the bound data storage.

Editor Settings and Repository Items

ActivePropertiesProvides access to the current editor 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 editor 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.CanModifyIdentifies if the editor is in read-only mode.IsEditValidating | IsHiding | IsPostingAllow you to identify the current operation in the editor.ShowHintSpecifies if the standalone editor can display hints.SupportsSpellingIdentifies if the editor supports the TdxSpellChecker component.Width | HeightAllow 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.

Inheritance

Show 15 items

TObject TPersistent TComponent TControl TWinControl TCustomControl TcxCustomControl TcxControl TcxContainer TcxCustomEditContainer TcxCustomEdit TcxCustomTextEdit TcxCustomMaskEdit TcxCustomButtonEdit TcxDBButtonEdit

See Also

TcxButtonEdit Class

TcxDBButtonEdit Members

cxDBEdit Unit