ColumnView.GetRowCellDisplayText(Int32, GridColumn) Method

Returns a specific cell's display value from the current View.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v20.1.dll

Declaration

public virtual string GetRowCellDisplayText(
    int rowHandle,
    GridColumn column
)
Public Overridable Function GetRowCellDisplayText(
    rowHandle As Integer,
    column As GridColumn
) As String

Parameters

Name Type Description
rowHandle Int32

An integer value specifying the handle of the row where the desired cell resides. Row handles are not data source indexes, see the Accessing Rows in Code. Row Handles section of the "Rows" article for more information.

column GridColumn

A GridColumn object or descendant representing a column containing the desired cell.

Returns

Type Description
String

A String value representing a cell's display text.

Remarks

Use the GetRowCellDisplayText method to obtain a textual representation of a specific cell value. The returned string is formatted as specified by the GridColumn.DisplayFormat property of the column where the specified cell resides. If you need to obtain the actual cell value, use the ColumnView.GetRowCellValue method instead.

The GetRowCellDisplayText method returns an empty string in the following cases:

  • the specified row handle doesn't point to any of the rows within the current View or points to a group row;
  • the specified column doesn't belong to the View or is a null reference.
NOTE

In Instant Feedback Mode, this GetRowCellDisplayText method has limitations. It returns a correct value only if the target row has been loaded. Otherwise, it returns an empty string.

NOTE

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetRowCellDisplayText member must not be invoked for these Views. The GetRowCellDisplayText member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

See Also