TcxDBTextEdit Class
A data-aware single-line text editor.
Declaration
TcxDBTextEdit = class(
TcxCustomTextEdit
)Remarks
A single-line text editor allows users to edit a non-formatted string value stored in a database.
Main API Members
The list below outlines key members of the TcxDBTextEdit class. These members allow you to configure data-aware text 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
- 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 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.
- 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 TcxEditRepositoryTextItem component in an edit repository to store text editor settings and share them between multiple single-line text editors.
Limitations and Considerations
The TcxDBTextEdit component is available only as a standalone editor. You cannot use data-aware editors as in-place editors in container controls.