TcxCustomDataController.GetRowDisplayText(TcxRowInfo,Integer) Method

Returns the display text for an item of a specific row.

Declaration

function GetRowDisplayText(const ARowInfo: TcxRowInfo; var AItemIndex: Integer): string;

Parameters

Name	Type
ARowInfo	TcxRowInfo
AItemIndex	Integer

Returns

Type
string

Remarks

The GetRowDisplayText function allows you to obtain the display text for a specific row (data records and grouping rows). The row is identified by the ARowInfo parameter. It specifies a TcxRowInfo object that can be obtained using the GetRowInfo function.

The AItemIndex parameter specifies the index of the item for which to return the display text. It identifies the position of the item within the collection of all items. In the ExpressQuantumGrid control, you can use the TcxCustomGridTableItem.Index property value for this parameter.

Note that if the ARowInfo parameter refers to a grouping row, the function returns the display text of the corresponding grouping item and ignores the AItemIndex parameter.

To get a variant value instead of its text representation, use the GetRowValue function.

If you only need to return the display text of data records (including records currently invisible because of filtering, for instance), you can use the DisplayTexts property. This property does not return display texts for grouping rows.