GridView.GetFocusedValue() Method

Returns the focused cell’s value.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

public override object GetFocusedValue()

VB.NET

Public Overrides Function GetFocusedValue As Object

Returns

Type	Description
Object	An object representing the focused cell’s value.

Remarks

If a group row is focused the GetFocusedValue method returns the value of the grouping column against which the data is grouped (the same value as the one returned by the GridView.GetGroupRowValue method). Otherwise, this method returns the focused cell’s value.

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

The following methods can be used to get the display values of specific cells: GridView.GetFocusedDisplayText, ColumnView.GetFocusedRowCellDisplayText and ColumnView.GetRowCellDisplayText.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetFocusedValue member must not be invoked for these Views. The GetFocusedValue 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 GetFocusedValue() 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-synchronize-the-selection-in-the-gridcontrol-and-the-pivotgridcontrol-e2065/CS/Q248711/Form1.cs#L23

private void OnGridViewFocusedColumnChanged(object sender, FocusedColumnChangedEventArgs e) {
    UpdatePivotSelection(pivotGrid, e.FocusedColumn.FieldName, ((GridView)sender).GetFocusedValue());
}

how-to-show-error-icons-for-cells-which-belong-to-an-unbound-column-gridcontrol-e1933/CS/Form1.cs#L72

{
    string error = GetError(gridView1.GetFocusedValue(), gridView1.FocusedRowHandle, gridView1.FocusedColumn);
    if (error == string.Empty) return;

VB.NET

how-to-synchronize-the-selection-in-the-gridcontrol-and-the-pivotgridcontrol-e2065/VB/Q248711/Form1.vb#L25

Private Sub OnGridViewFocusedColumnChanged(ByVal sender As Object, ByVal e As FocusedColumnChangedEventArgs) Handles gridView1.FocusedColumnChanged
    UpdatePivotSelection(pivotGrid, e.FocusedColumn.FieldName, (CType(sender, GridView)).GetFocusedValue())
End Sub

how-to-show-error-icons-for-cells-which-belong-to-an-unbound-column-gridcontrol-e1933/VB/Form1.vb#L80

Private Sub gridView1_ShownEditor(ByVal sender As Object, ByVal e As EventArgs) Handles gridView1.ShownEditor
    Dim [error] As String = GetError(gridView1.GetFocusedValue(), gridView1.FocusedRowHandle, gridView1.FocusedColumn)
    If [error] = String.Empty Then