Skip to main content

ASPxClientVerticalGrid.GetRecordKey(visibleIndex) Method

Returns the key value of the specified data row (record in the vertical grid).

#Declaration

TypeScript
GetRecordKey(
    visibleIndex: number
): string

#Parameters

Name Type Description
visibleIndex number

The record’s visible index.

#Returns

Type Description
string

A string representing the specified data row’s key value. If the index passed using the visibleIndex parameter is wrong or the ASPxGridBase.KeyFieldName property is not set, null is returned.

#Remarks

The GetRecordKey method is in effect for data rows (records in vertical grid) only - it does not work for category rows.

Note

If multiple key fields are set using the grid’s ASPxGridBase.KeyFieldName property, a specific service vertical bar symbol (the symbol |) is used to separate key field values in the string returned by the GetRecordKey method.

See Also