TcxCustomEdit Class

The base class for all editor components.

Declaration

TcxCustomEdit = class(
    TcxCustomEditContainer,
    IcxEditRepositoryItemListener,
    IcxInplaceEditIMEHelper,
    IdxSkinSupport,
    IdxSpellCheckerControl,
    IdxFadingObject,
    IcxEditOwner,
    IdxTouchModeSupport,
    IdxAutomationElementWithRepositoryItem
)

Remarks

The ExpressEditors Library ships with over 40 data editor types you can use as standalone controls for data input forms or in-place editors embedded into container controls (Data Grid, Tree List, Vertical Grid, Pivot Grid, Ribbon UI, etc.). An in-place editor exists (and, therefore, has its own WinAPI handle) only when a user activates it. Otherwise, the target container control displays a static editor image for resource usage optimization.

Most data editors (such as text, spin, or mask editors) are designed to display data in a specific manner and allow users to edit data. Certain editors (such as bar code or formatted label editors) have no data edit functionality.

The TcxCustomEdit class implements the base functionality common to all data editors.

Main API Members

The list below outlines key members of the TcxCustomEdit class that allow you to configure 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.

Note

Only data-aware editors publish these API members.

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. Only data-aware editors publish this property.
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. To enable hints for an in-place editor in a container control, set its OptionsBehavior.CellHints^[1] property to True.
SupportsSpelling: Identifies if the editor supports the TdxSpellChecker component.
Width | Height: Allow you to explicitly define editor dimensions.

Terminal TcxCustomEdit Class Descendants

Terminal TcxCustomEdit class descendants include all unbound and data-aware editors shipped with the ExpressEditors Library. Do not create TcxCustomEdit class instances. You can derive descendants from the TcxCustomEdit class and override its virtual methods to create custom editors with support for DevExpress Skins and editor integration mechanisms.

Note

Non-editor controls shipped with the ExpressEditors Library are not derived from the TcxCustomEdit class. For example, TcxButton, TcxClock, TcxFilterControl, TcxHeader, and TcxNavigator.

Unbound Editors

You can use any unbound editor as a standalone control or an in-place editor embedded into a container control.

The ExpressEditors Library includes the following unbound editors:

TcxBlobEdit: The BLOB editor.
TcxButtonEdit: An unbound single-line text editor with embedded buttons.
TcxCalcEdit: An editor with a dropdown calculator window.
TcxCheckBox: Represents a check box control that allows selecting an option.
TcxCheckComboBox: An unbound combo box editor that can display items with check boxes.
TcxCheckGroup: An editor displaying a set of check boxes.
TcxCheckListBox: A list box control that enables checking/un-checking of one or more items.
TcxColorComboBox: Represents a color combo box control.
TcxComboBox: An unbound combo box.
TcxCurrencyEdit: An editor that enables editing currency data.
TcxDateEdit: TcxDateEdit is an edit control with a dropdown calendar.
TcxFontNameComboBox: Represents a combo box control containing font names available for selection.
TcxGroupBox: Represents the group box control.
TcxHyperLinkEdit: An unbound hyperlink editor.
TcxImage: An unbound image editor.
TcxImageComboBox: An unbound combo box with support for images.
TcxLabel: Represents the label control.
TcxMaskEdit: TcxMaskEdit implements a generic masked edit control.
TcxMemo: Represents an edit control that allows editing memo data.
TcxMRUEdit: Represents a text editor displaying the list of most recently used items (MRU) within a dropdown window.
TcxPopupEdit: Represents a text editor that enables embedding another control in its popup window.
TcxProgressBar: Represents an advanced progress bar control.
TcxRadioGroup: A container for radio buttons, functioning together.
TcxRichEdit: Represents an edit control which allows rich text to be edited.
TcxShellComboBox: A Shell Combo Box editor.
TcxSpinButton: Represents the spin button.
TcxSpinEdit: Represents a spin editor.
TcxTextEdit: An unbound single-line text editor.
TcxTimeEdit: Represents an editor displaying time values.
TcxTrackBar: Represents the track bar editor that is used to edit values using a thumb.
TdxBarCode: An unbound barcode control.
TdxCheckGroupBox: An unbound checkable group box editor.
TdxColorEdit: An editor that allows users to pick a color from a color gallery embedded into a dropdown window.
TdxDateTimeWheelPicker: An unbound date-time wheel picker editor.
TdxFormattedLabel: An unbound formatted label control.
TdxNumericWheelPicker: An unbound numeric value wheel picker editor.
TdxOfficeSearchBox: A search box suggesting Ribbon or Toolbar UI elements based on the entered text.
TdxRangeTrackBar: An unbound range track bar editor.
TdxRatingControl: An unbound rating control.
TdxSparklineEdit: An unbound sparkline editor.
TdxToggleSwitch: An unbound toggle switch editor.
TdxTokenEdit: An unbound token editor.
TdxWheelPicker: A generic value wheel picker editor.
TdxZoomTrackBar: An unbound zoom track bar editor similar to the zoom slider found in Microsoft Office.

Data-Aware Editors

Data-aware editors are designed to display and modify field values in the underlying dataset. You can use the DataBinding property to bind a data-aware editor directly to a dataset field.

Note

Not every unbound editor has a data-aware counterpart.
If an editor has both unbound and data-aware versions, you can only use its unbound version as an in-place editor.

The ExpressEditors Library ships with the following data-aware editors:

TcxDBBlobEdit: Represents a data-aware control used for displaying and editing BLOB data from a data source.
TcxDBButtonEdit: A data-aware single-line text editor with embedded buttons.
TcxDBCalcEdit: Represents a data-aware control that enables editing a value via a popup calculator.
TcxDBCheckBox: Represents a data-aware control which supports “checked”, “unchecked” and “grayed” states.
TcxDBCheckComboBox: A data-aware combo box editor that can display items with check boxes.
TcxDBCheckGroup: Represents a data-aware check group control.
TcxDBCheckListBox: Represents the data-aware version of the TcxCheckListBox control.
TcxDBColorComboBox: Represents the data-aware version of the TcxColorComboBox.
TcxDBComboBox: A data-aware combo box.
TcxDBCurrencyEdit: A data-aware editor that enables editing currency data.
TcxDBDateEdit: Represents a data-aware edit control with a dropdown calendar that enables editing date values.
TcxDBFontNameComboBox: Represents a data-aware version of the TcxFontNameComboBox.
TcxDBHyperLinkEdit: A data-aware hyperlink editor.
TcxDBImage: A data-aware image editor.
TcxDBImageComboBox: A data-aware image combo box.
TcxDBLabel: Represents data-aware version of the TcxLabel.
TcxDBMaskEdit: Represents a masked editor that enables displaying and editing text fields within a dataset.
TcxDBMemo: Represents a memo editor that enables editing dataset fields.
TcxDBMRUEdit: Represents a data-aware text editor that stores the list of most recently used items and allows the selection of a value from this list.
TcxDBPopupEdit: Represents a data-aware text editor with a popup window embedding a control.
TcxDBProgressBar: Represents the data-aware version of the TcxProgressBar.
TcxDBRadioGroup: Represents a data-aware version of the radio group control.
TcxDBRichEdit: Represents a data-aware version of the TcxRichEdit control.
TcxDBShellComboBox: Represents the data-aware version of the shell combo box control.
TcxDBSpinEdit: Represents a spin editor, which enables editing numerical dataset fields.
TcxDBTimeEdit: Represents a data-aware editor which enables editing time values.
TcxDBTrackBar: Represents the data-aware version of the TcxTrackBar.
TdxDBBarCode: A data-aware barcode control.
TdxDBCheckGroupBox: A data-aware checkable group box editor.
TdxDBColorEdit: A data-aware color editor control.
TdxDBDateTimeWheelPicker: A data-aware date-time wheel picker editor.
TdxDBFormattedLabel: A data-aware formatted label control.
TdxDBLookupSparklineEdit: A data-aware lookup sparkline editor.
TdxDBNumericWheelPicker: A data-aware numeric value wheel picker editor.
TdxDBRangeTrackBar: A data-aware range track bar editor.
TdxDBRatingControl: A data-aware rating control.
TdxDBSparklineEdit: A data-aware sparkline editor.
TdxDBToggleSwitch: A data-aware toggle switch editor.
TdxDBTokenEdit: A data-aware token editor.
TdxDBZoomTrackBar: A data-aware zoom track bar editor similar to the zoom slider found in Microsoft Office.

Implements

IcxEditRepositoryItemListener

IcxInplaceEditIMEHelper

IdxSkinSupport

IdxSpellCheckerControl

IdxFadingObject

IcxEditOwner

IdxTouchModeSupport

Inheritance

Show 11 items

TcxCustomEditContainer

TcxCustomEdit

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.

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

TcxCustomEdit Class

Declaration

Remarks

Main API Members

Appearance Settings

Editor Settings and Repository Items

General-Purpose API Members

Terminal TcxCustomEdit Class Descendants

Unbound Editors

Data-Aware Editors

Implements

Inheritance

TcxCustomEdit Class

Declaration

Remarks

Main API Members

Appearance Settings

Content-Related APIs

Data-Related APIs

Editor Settings and Repository Items

General-Purpose API Members

Terminal TcxCustomEdit Class Descendants

Unbound Editors

Data-Aware Editors

Implements

Inheritance