Skip to main content

TcxVerticalGridGetEditPropertiesEvent Type

The procedural type for in-place editor setting retrieval events in a Vertical Grid control.

Declaration

TcxVerticalGridGetEditPropertiesEvent = procedure(Sender: TcxCustomEditorRowProperties; ARecordIndex: Integer; var AProperties: TcxCustomEditProperties) of object;

Parameters

Name Type Description
Sender TcxCustomEditorRowProperties

Provides access to settings of the vertical grid row that raised the current editor setting retrieval event.

To access all public API members of a vertical grid row settings class, cast the Sender parameter value to one of the following classes depending on the actual vertical grid row settings type:

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.

Tip

To identify the vertical grid row settings type, call the Sender.ClassType function.

ARecordIndex Integer

Returns the record index of the currently processed data cell.

AProperties TcxCustomEditProperties

Specifies in-place editor settings for the currently processed data cell in the vertical grid row and record identified by Sender and ARecordIndex parameters, respectively.

You can use the AProperties parameter to identify the active in-place editor and its settings. To access all public API members of the active in-place editor settings instance, cast the AProperties parameter value to the corresponding editor settings class.

To identify the actual editor settings class, call the AProperties.ClassType function.

Important

Do not change individual in-place editor settings accessible through the AProperties parameter to avoid possible drawing errors and access violations. To change the active in-place editor or its settings in a safe manner, assign the Properties property value of a preconfigured edit repository item to the AProperties parameter.

Remarks

Editor setting retrieval events occur when a Vertical Grid control is about to determine the required editor for a data cell. You can handle these events to change in-place editors in rows based on custom conditions.

TcxVerticalGridGetEditPropertiesEvent Type References

OnGetEditProperties and OnGetEditingProperties events of a vertical grid row reference the TcxVerticalGridGetEditPropertiesEvent procedural type.

See Also