TcxDBCurrencyEdit Class
A data-aware currency editor.
#Declaration
TcxDBCurrencyEdit = class(
TcxCustomCurrencyEdit
)
#Remarks
A currency editor is a numeric editor designed to work with monetary values.
#Main API Members
The list below outlines key members of the TcxCustomCurrencyEdit
class. These members allow you to configure currency 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 Tcx
Edit component. If you need to apply the same style settings to all editors in your application, you can use a TcxStyle Controller Default component.Edit Style Controller - 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
- Clear
- Clears the editor.
- CopyToClipboard | CutToClipboard | PasteFromClipboard
- Allow you to perform clipboard operations.
- EditValue | Value
- Specify 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.
#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. 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.
- 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 TcxEditRepositoryCurrencyItem component in an edit repository to define an unbound currency editor, store currency editor settings, and share them between multiple currency editors.
#Limitations
The data-aware currency editor is designed as a standalone editor. You cannot use a TcxDBCurrencyEdit
class instance as an in-place editor in container controls.