TcxCustomEditorRowProperties Class
The base class for all classes that implement vertical grid row settings.
Declaration
TcxCustomEditorRowProperties = class(
TcxCaptionRowProperties,
IcxEditorPropertiesContainer
)Remarks
The TcxCustomEditorRowProperties class implements settings common to all vertical grid row types.
In-Place Editors
A vertical grid row can use any editor shipped with the ExpressEditors Library as an in-place editor for cell edit operations. An in-place editor instance exists (and, therefore, has its own WinAPI handle) only when a row cell is being edited. Otherwise, the column displays a static editor image for resource usage optimization.
To switch between available in-place editors, you can use the EditPropertiesClass property. Use the EditProperties property to configure the in-place editor associated with the vertical grid row.
In-Place Editors and Repository Items
Alternatively, you can assign an edit repository item component to the RepositoryItem property and use the repository item to define the active in-place editor and customize its settings.
Note
If an edit repository item is assigned to the RepositoryItem property, EditProperties, EditPropertiesClass, and EditPropertiesClassName properties have no effect.
Multiple In-Place Editors in One Row
You can handle OnGetEditProperties and OnGetEditingProperties events to dynamically change the assigned in-place editor and its settings based on custom conditions.
Important
Do not change EditPropertiesClass, EditPropertiesClassName, and EditProperties property values directly in OnGetEditProperties and OnGetEditingProperties event handlers.
To change the active editor and modify its settings safely within these event handlers, use the RepositoryItem property and TcxEditRepositoryItem class descendants.
Main API Members
The list below outlines key members of the TcxCustomEditorRowProperties class that allow you to configure vertical grid rows.
Appearance Customization
- OnGetDisplayText
- Allows you to change display text for individual cells.
- OnGetFilterImages | OnGetFilterValues
- Allow you to customize the vertical grid row’s filter drop-down window.
In-Place Editor Settings
- DisplayEditProperties
- Returns active in-place editor settings for individual grid row cells by their indexes.
- EditProperties
- Allows you to customize the settings of the assigned in-place editor.
- EditPropertiesClass
- Specifies the active in-place editor class. At design time, you can use the EditProperties node in the Object Inspector to assign an in-place editor to the vertical grid row and configure the editor.
- OnGetEditProperties
- Allows you to display different in-place editors for different records or customize editor settings based on custom conditions.
- OnGetEditingProperties
- Allows you to change the assigned in-place editor and customize its settings when a user invokes the editor.
- PropertiesValue
- Provides access to active in-place editor settings.
- RepositoryItem
Allows you to associate the vertical grid row with a repository item that defines the required in-place editor and its settings.
Tip
Repository items are particularly useful if you need to share in-place editor settings between multiple vertical grid rows or customize editor settings in OnGetEditProperties and OnGetEditingProperties event handlers.
Data Management
- DataBinding
- Provides access to data binding settings.
- Value
- Allows you to access and modify the edited cell value.
- Values | DisplayTexts
- Return values and display text strings of individual grid row cells by their indexes.
Vertical Grid Control-Related API Members
- ItemIndex
- Returns the vertical grid row’s index.
- ShowExpressionEditor
- Invokes the Expression Editor dialog.
- VisibleForExpressionEditor
- Specifies if the vertical grid row is visible in the Expression Editor dialog.
General-Purpose API Members
- Options
- Allows you to configure end-user permissions for the grid row.
Terminal TcxCustomEditorRowProperties Class Descendants
Do not use the TcxCustomEditorRowProperties class directly. Use the following descendants instead:
- TcxDBEditorRowProperties
- Represents settings that define the data-aware editor row behavior.
- TcxEditorRowProperties
- Stores vertical grid row settings in unbound mode.
- TcxCollectionItemEditorRowProperties
- Represents a base class for the multi editor row items.
- TcxDBEditorRowItemProperties
- Contains settings that define behavior of a data-aware item in the multi editor row.
- TcxEditorRowItemProperties
- Contains settings that define the appearance and behavior of an item in a multi editor row.