TcxCustomGridTableItem.GetProperties(Integer) Method

Returns the properties of an editor used to edit the values of the current item.

Declaration

function GetProperties(ARecordIndex: Integer): TcxCustomEditProperties; overload;

Parameters

Name	Type
ARecordIndex	Integer

Returns

Type
TcxCustomEditProperties

Remarks

The GetProperties method returns the properties of the editor used to edit the values of the current item. You can use the object returned by the GetProperties method to adjust specific settings of the item’s editor. For instance, if the item uses a currency editor, GetProperties returns an object of the TcxCurrencyEditProperties class. It provides properties such as DisplayFormat, DecimalPlaces, MaxValue, MinValue etc.

By default, an item is assigned a specific editor based on the DataBinding.ValueTypeClass value (in unbound mode) and the field type (in bound mode). Refer to the FieldName property and the TcxValueType class topic for details.

You can redefine the default editor and specify it explicitly. This allows you to adjust the editor’s properties at design time. Use the RepositoryItem or the PropertiesClass property. See the corresponding topics for more details.

The GetProperties method returns editor properties regardless of whether the default or an explicitly assigned editor is used.

The OnGetProperties event allows you to specify different editors for individual cells of the current item. In this instance, you should call the second overloaded method to ascertain the actual item editor being used for a particular record.