TcxGridGetPropertiesEvent Type

The procedural type for in-place editor setting retrieval events in the Data Grid control.

Declaration

TcxGridGetPropertiesEvent = procedure(Sender: TcxCustomGridTableItem; ARecord: TcxCustomGridRecord; var AProperties: TcxCustomEditProperties) of object;

Parameters

Name	Type	Description
Sender	TcxCustomGridTableItem	Provides access to the grid table item that raised the current editor setting retrieval event. To access all public API members of a grid table item, cast the Sender parameter value to one of the following classes depending on the actual grid table item type: TcxGridColumn A column in an unbound grid Table View. TcxGridBandedColumn A column in an unbound Banded Table View. TcxGridDBColumn A column in a data-aware grid Table View. TcxGridDBBandedColumn A column in a data-aware Banded Table grid View. TcxGridServerModeColumn A column in a Server Mode grid Table View. TcxGridServerModeBandedColumn A column of a Banded Table View in Server Mode. TcxGridCardViewRow An unbound Card View row. TcxGridDBCardViewRow A data-aware Card View row. TcxGridLayoutViewItem A Layout View‘s data item. TcxGridDBLayoutViewItem A data-aware Layout View’s data item. TcxGridWinExplorerViewItem TcxGridDBWinExplorerViewItem Tip To identify the grid table item type, call the Sender.ClassType function.
ARecord	TcxCustomGridRecord	Provides access to the currently processed record. For example, you can use the ARecord.RecordIndex property to identify the record.
AProperties	TcxCustomEditProperties	Specifies in-place editor settings for the currently processed data cell in the table item and record accessible through Sender and ARecord 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, cast the AProperties parameter 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 instead.

Remarks

Editor setting retrieval events occur when a grid View is about to determine the required editor for a data cell. You can handle these events to change in-place editors in data items depending on custom conditions.

TcxGridGetPropertiesEvent Type References

OnGetProperties and OnGetPropertiesForEdit events of a grid table item reference the TcxGridGetPropertiesEvent procedural type.