TcxPivotGridGetPropertiesEvent Type

The procedural type for editor setting retrieval events in a Pivot Grid control.

Declaration

TcxPivotGridGetPropertiesEvent = procedure(Sender: TcxPivotGridField; ACell: TcxPivotGridCustomCellViewInfo; var AProperties: TcxCustomEditProperties) of object;

Parameters

Name	Type	Description
Sender	TcxPivotGridField	Provides access to the pivot grid field that raised the current editor setting retrieval event. The Sender parameter returns a TcxPivotGridField object in unbound and provider data access modes. In other modes, you need to cast the Sender parameter value to one of the following classes depending on the actual pivot grid field type to access all public API members: TcxPivotGridOLAPField A Pivot Grid field designed for OLAP Mode. TcxDBPivotGridField A data-aware Pivot Grid field.
ACell	TcxPivotGridCustomCellViewInfo	Provides access to ViewInfo information of the currently processed pivot grid cell.
AProperties	TcxCustomEditProperties	Specifies editor settings for the currently processed cell in the pivot grid field accessible through the Sender parameter. You can use the AProperties parameter to identify the active editor and its settings. To access all public API members of the active editor settings object, cast the AProperties parameter value to the corresponding editor settings class. To identify the actual editor settings class, call the AProperties.ClassName function. Important Do not change individual editor settings accessible through the AProperties parameter to avoid possible drawing errors and access violations. To change the active editor or its settings in a safe manner, assign the Properties property value of a preconfigured edit repository item to the AProperties parameter.

Remarks

An editor setting retrieval event occurs when a pivot grid field is about to determine the required editor for a data cell. You can handle this event to change editors in individual cells depending on custom conditions.

TcxPivotGridGetPropertiesEvent Type References

The OnGetProperties event of a pivot grid field references the TcxPivotGridGetPropertiesEvent procedural type.