ColumnView.GetFocusedDisplayText() Method

Returns the focused cell’s display value.

Namespace : DevExpress.XtraGrid.Views.Base

Assembly : DevExpress.XtraGrid.v25.2.dll

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

Declaration

C#
VB.NET

csharp

public virtual string GetFocusedDisplayText()

Public Overridable Function GetFocusedDisplayText As String

Returns

Type	Description
String

A string representing the text displayed within the View’s focused cell.

Remarks

Use the GetFocusedDisplayText method to obtain the text representation of the currently focused cell’s value. The returned string is formatted as specified by the GridColumn.DisplayFormat property of the column in which the specified cell resides. To obtain the actual value of the cell, use the ColumnView.GetFocusedValue method.

The currently focused cell is determined by the focused column specified by the ColumnView.FocusedColumn property and the focused row referred to by the ColumnView.FocusedRowHandle property.

To get the text displayed in other cells in the focused row use the ColumnView.GetFocusedRowCellDisplayText method.

The ColumnView.GetRowCellDisplayText method can be used to get the display text of any column in any row.

The following methods can be used to get edit values of specific cells: ColumnView.GetFocusedValue, ColumnView.GetFocusedRowCellValue and ColumnView.GetRowCellValue.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetFocusedDisplayText member must not be invoked for these Views. The GetFocusedDisplayText 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.