GridView.GetFocusedDisplayText() Method

Returns the focused cell’s display value.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public override string GetFocusedDisplayText()

VB.NET

Public Overrides Function GetFocusedDisplayText As String

Returns

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

Remarks

If a group row is currently focused the GetFocusedDisplayText method returns the string which represents the text displayed by the group row (the same value as the one returned by the GridView.GetGroupRowDisplayText method). Otherwise, this method returns the text representation of the currently focused cell’s value. The returned string is formatted as specified by the GridColumn.DisplayFormat property of the focused column.

The focused cell in a Grid View is identified by the ColumnView.FocusedRowHandle and ColumnView.FocusedColumn properties.

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 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 GetFocusedDisplayText() 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-change-an-in-place-buttonedit-button-caption-in-different-rows-of-xtragrid-e903/CS/Form1.cs#L57

    ButtonEdit ed = (ButtonEdit)view.ActiveEditor;
    ed.Properties.Buttons[0].Caption = view.GetFocusedDisplayText();
}

how-to-copy-a-cells-value-to-other-cells-by-dragging-its-right-bottom-edge-e2621/CS/Classes/DragCellsValuesHelper.cs#L57

ToolTipController.DefaultController.HideHint();
string text = View.GetFocusedDisplayText();
if (string.IsNullOrEmpty(text))

VB.NET

how-to-change-an-in-place-buttonedit-button-caption-in-different-rows-of-xtragrid-e903/VB/Form1.vb#L51

    Dim ed As ButtonEdit = CType(view.ActiveEditor, ButtonEdit)
    ed.Properties.Buttons(0).Caption = view.GetFocusedDisplayText()
End If

how-to-copy-a-cells-value-to-other-cells-by-dragging-its-right-bottom-edge-e2621/VB/Classes/DragCellsValuesHelper.vb#L56

ToolTipController.DefaultController.HideHint()
Dim text As String = View.GetFocusedDisplayText()
If String.IsNullOrEmpty(text) Then