ColumnView.GetRowCellDisplayText(Int32, GridColumn) Method

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

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v24.1.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

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. 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 Views that display real data within the Grid Control. Use the following methods to access these Views with which an end user interacts at runtime.

• 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#

winforms-grid-find-row-by-display-text/CS/WindowsApplication1/GridViewSearch.cs#L59

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

winforms-grid-highlight-cell-values-matching-text-in-autofilterrow/CS/CarsGridWinApp15/Main.cs#L30

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

winforms-grid-forcibly-show-cell-tooltips/CS/AlwaysShowCellHints/Form1.cs#L25

if(info.InRowCell) {
    string text = view.GetRowCellDisplayText(info.RowHandle, info.Column);
    string cellKey = info.RowHandle.ToString() + " - " + info.Column.ToString();

VB.NET

winforms-grid-find-row-by-display-text/VB/WindowsApplication1/GridViewSearch.vb#L60

n += delta
Dim cellText As String = GetSearchGridView().GetRowCellDisplayText(n, SearchColumn)
If cellText.Contains(SearchText) Then Return n

winforms-grid-highlight-cell-values-matching-text-in-autofilterrow/VB/CarsGridWinApp15/Main.vb#L24

If Not view.OptionsView.ShowAutoFilterRow OrElse Not view.IsDataRow(e.RowHandle) Then Return
Dim filterCellText As String = view.GetRowCellDisplayText(GridControl.AutoFilterRowHandle, e.Column)
If String.IsNullOrEmpty(filterCellText) Then Return

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()