ASPxClientVerticalGridBatchEditApi.GetColumnDisplayText(columnFieldNameOrId, value) Method

Provides the text displayed within the cell according to the specified display format rule.

Declaration

GetColumnDisplayText(
    columnFieldNameOrId: string,
    value: any
): string

Parameters

Name	Type	Description
columnFieldNameOrId	string	A string value representing the row’s unique identifier or field name.
value	any	An object representing a value.

Returns

Type	Description
string	A string value representing the cell’s displayed text.

Example

The following example illustrates how to use the GetColumnDisplayText property.

C#

function OnBatchEditEndEditing(s, e) {
    var row = s.batchEditApi.GetEditCellInfo().row;
    if(row.fieldName == "SomeDate") { 
        var value = e.recordValues[row.index].value;
        value.setMonth(6);
        e.recordValues[row.index].value = value;
        e.recordValues[row.index].text = s.batchEditApi.GetColumnDisplayText(row, value);
    }
}

ASPX

<dx:VerticalGridDateRow FieldName="SomeDate">
    <PropertiesDateEdit DisplayFormatString="u" />
</dx:VerticalGridDateRow>