TcxCustomTextEdit Class
The base class for text box-based editors.
Declaration
TcxCustomTextEdit = class(
TcxCustomEdit,
IcxFormatControllerListener,
IdxAIControl,
IdxAITextControl
)Remarks
The TcxCustomTextEdit class implements core text box functionality for editors shipped with the ExpressEditors Library.
In this topic…
Main API Members
The list below outlines key members of the TcxCustomTextEdit class. These members allow you to configure editors and manage content.
Appearance Settings
- ParentColor
- Specifies if the editor uses its parent color to fill the background area.
- 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.
Content-Related APIs
- CanSmartPaste
- Identifies if the editor supports AI-powered Smart Paste operations.
- Clear
- Clears the editor.
- ClearSelection
- Deletes selected editor content.
- CopyToClipboard | CutToClipboard | PasteFromClipboard
- Allow you to perform clipboard operations.
- CursorPos
- Returns the caret position in the active editor.
- EditingText
- Allows you to modify editor content.
- 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 | SelLength | SelStart | SetSelection
- Manage text selection.
- TextHint
- Allows you to display a hint message while the inactive editor is empty.
- Undo
- Discards pending changes made in the active editor.
- ValidateEdit
- Validates the display value.
Data-Related APIs
Note
Only data-aware TcxCustomTextEdit descendants expose these API members in the Object Inspector.
- 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 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 toTrue. - SupportsSpelling
- Identifies if the editor supports the TdxSpellChecker component.
- Width | Height
- Allow you to explicitly define editor dimensions.
Terminal TcxCustomTextEdit Class Descendants
Terminal TcxCustomTextEdit class descendants include all unbound and data-aware text box-based editors shipped with the ExpressEditors Library. Do not create TcxCustomTextEdit class instances. Use the following descendants instead:
B
- TcxBlobEdit | TcxDBBlobEdit
- A BLOB (Binary Large Object) editor that can display an image or text in a drop-down window.
- TcxButtonEdit | TcxDBButtonEdit
- A single-line text editor with embedded buttons.
C
- TcxCalcEdit | TcxDBCalcEdit
- A numeric editor with a drop-down calculator window.
- TcxCheckComboBox | TcxDBCheckComboBox
- A check box editor that can display items with check boxes.
- TcxColorComboBox | TcxDBColorComboBox
- A combo box editor designed for color selection.
- TcxComboBox | TcxDBComboBox
- A general-purpose combo box editor.
- TcxCurrencyEdit | TcxDBCurrencyEdit
- A numeric editor for currency values.
- TdxColorEdit | TdxDBColorEdit
- An editor designed to select a color in a color gallery embedded into a drop-down window.
D
- TcxDateEdit | TcxDBDateEdit
- A date editor with a drop-down calendar.
E
- TcxExtLookupComboBox | TcxDBExtLookupComboBox
- A lookup editor that displays a Data Grid View in a drop-down window.
F
- TcxFontNameComboBox | TcxDBFontNameComboBox
- A combo box that allows users to switch between font typefaces.
H
- TcxHyperLinkEdit | TcxDBHyperLinkEdit
- A hyperlink Editor that can execute custom commands.
I
- TcxImageComboBox | TcxDBImageComboBox
- A combo box designed to display both text and images in items.
L
- TcxLookupComboBox | TcxDBLookupComboBox
- A lookup combo box that displays a multi-column table in a drop-down window.
M
- TcxMaskEdit | TcxDBMaskEdit
- A single-line text editor with support for input masks.
- TcxMemo | TcxDBMemo
- A multi-line editor for plain text.
- TcxMRUEdit | TcxDBMRUEdit
- A single-line text editor that displays a list of most recently used (MRU) items in a drop-down window.
O
- TdxOfficeSearchBox
- A search box editor designed to list Ribbon or toolbar UI elements based on user input.
P
- TcxPopupEdit | TcxDBPopupEdit
- A single-line text editor that can embed a control in a pop-up window.
R
- TcxRichEdit | TcxDBRichEdit
- A multi-line rich text editor designed to work with Rich Text Format (RTF) documents.
S
- TcxSpinEdit | TcxDBSpinEdit
- A general-purpose numeric spin editor.
T
- TcxTextEdit | TcxDBTextEdit
- A single-line text box editor.
- TcxTimeEdit | TcxDBTimeEdit
- A spin editor for time values.
- TdxTokenEdit | TdxDBTokenEdit
- A text editor designed to validate input and convert matching words into tokens (clickable boxes designed to display a caption and an image).
Implements
Inheritance
Footnotes
-
Set the following behavior properties to
TrueorFalseto 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.
See Also