TcxCustomInplaceEditContainer Class

The base class for columns in Tree List controls.

Declaration

TcxCustomInplaceEditContainer = class(
    TComponent,
    IcxEditRepositoryItemListener,
    IcxEditorPropertiesContainer,
    IdxScaleFactor,
    IdxDateTimeHandling,
    IdxExcelFilterableComponent,
    IdxFilteringDateTimeHandling,
    IdxFilterableComponent,
    IdxFilterImagesProvider
)

Remarks

The TcxCustomInplaceEditContainer class implements column functionality in Tree List columns.

In-Place Editors

A tree list column 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 column cell is being edited. Otherwise, the column displays a static editor image for resource usage optimization.

VCL Tree List: An In-Place Date Editor

To switch between available in-place editors, you can use the PropertiesClass property. Use the Properties property to configure the in-place editor associated with the column.

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, Properties, PropertiesClass, and PropertiesClassName properties have no effect.

Multiple In-Place Editors in One Column

You can handle a tree list column’s OnGetEditProperties and OnGetEditingProperties events to dynamically change the assigned in-place editor and its settings based on custom conditions.

VCL Tree List: Multiple In-Place Editors Per Column

Important

Do not change PropertiesClass, PropertiesClassName, and Properties 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 TcxCustomInplaceEditContainer class that allow you to configure columns in a Tree List control.

Appearance Customization

OnGetFilterImages | OnGetFilterValues: Allow you to customize the tree list column’s filter drop-down window.
Styles: Allows you to change the appearance of different tree list column elements.

In-Place Editor Settings

Editing: Specifies if the assigned in-place cell editor is active.
EditValue: Allows you to access and modify the edited cell value.
Properties: Allows you to customize the settings of the assigned in-place editor.
PropertiesValue: Provides access to active in-place editor settings.
PropertiesClass: Specifies the active in-place editor class. At design time, you can use the Properties node in the Object Inspector to assign an in-place editor to the tree list column and configure the editor.
RepositoryItem: Allows you to associate the tree list column 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 tree list columns or customize editor settings in OnGetEditProperties and OnGetEditingProperties event handlers.

Focused: Specifies if the tree list column has focus.
ItemIndex: Returns the column’s index.
ShowExpressionEditor: Invokes the Expression Editor dialog.
VisibleForExpressionEditor: Specifies if the column is visible in the Expression Editor dialog.