ColumnView.GetRowCellDisplayText(Int32, GridColumn) Method

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

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public virtual string GetRowCellDisplayText(
    int rowHandle,
    GridColumn column
)

VB.NET

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.
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.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetRowCellDisplayText(Int32, GridColumn) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-iterate-through-data-rows-and-apply-styles-to-the-corresponding-grid-cells-e537/CS/Form1.cs#L157

foreach(DevExpress.XtraGrid.Columns.GridColumn column in gridView1.Columns) {
    string cellValue = gridView1.GetRowCellDisplayText(j, column);

how-to-delay-processing-a-time-consuming-event-handler-e775/CS/Form1.cs#L168

// The indicator that the process is completed
label1.Text = gridView1.GetRowCellDisplayText(
    gridView1.FocusedRowHandle, gridView1.Columns["RowName"]);

how-to-display-a-check-box-to-indicate-a-value-presence-in-another-grid-columns-cell-e522/CS/EditorStatusViaCustomDraw/Form1.cs#L32

else
    text = grid.GetRowCellDisplayText(e.RowHandle, grid.Columns["Column1"]);
isChecked = (text != null && text != string.Empty);

how-to-enable-gridview-to-highlight-text-matching-text-typed-in-the-autofilterrow-in-cells-e3134/CS/CarsGridWinApp15/Main.cs#L30

string filterCellText = view.GetRowCellDisplayText(GridControl.AutoFilterRowHandle, e.Column);
if ( String.IsNullOrEmpty(filterCellText) )

how-to-locate-a-row-by-display-text-e2147/CS/WindowsApplication1/GridViewSearch.cs#L59

string cellText = GetSearchGridView().GetRowCellDisplayText(n, SearchColumn);
if (cellText.Contains(SearchText)) return n;

VB.NET

how-to-iterate-through-data-rows-and-apply-styles-to-the-corresponding-grid-cells-e537/VB/Form1.vb#L157

For Each column As DevExpress.XtraGrid.Columns.GridColumn In gridView1.Columns
    Dim cellValue As String = gridView1.GetRowCellDisplayText(j, column)

how-to-delay-processing-a-time-consuming-event-handler-e775/VB/Form1.vb#L162

' The indicator that the process is completed
label1.Text = gridView1.GetRowCellDisplayText(gridView1.FocusedRowHandle, gridView1.Columns("RowName"))
label1.Refresh()

how-to-display-a-check-box-to-indicate-a-value-presence-in-another-grid-columns-cell-e522/VB/EditorStatusViaCustomDraw/Form1.vb#L33

Else
    text = grid.GetRowCellDisplayText(e.RowHandle, grid.Columns("Column1"))
End If

how-to-enable-gridview-to-highlight-text-matching-text-typed-in-the-autofilterrow-in-cells-e3134/VB/CarsGridWinApp15/Main.vb#L28

Dim filterCellText As String = view.GetRowCellDisplayText(GridControl.AutoFilterRowHandle, e.Column)
If String.IsNullOrEmpty(filterCellText) Then

winforms-grid-forcibly-show-cell-tooltips/VB/AlwaysShowCellHints/Form1.vb#L28

Dim text_Renamed As String = view.GetRowCellDisplayText(info.RowHandle, info.Column)
Dim cellKey As String = info.RowHandle.ToString() & " - " & info.Column.ToString()