GridControl.FocusedView Property

Gets or sets the View which is currently focused.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[Browsable(false)]
public BaseView FocusedView { get; set; }

VB.NET

<Browsable(False)>
Public Property FocusedView As BaseView

Property Value

Type	Description
BaseView	A BaseView descendant which represents the focused View.

Remarks

When the grid control is working in master-detail mode, it can display a number of Views simultaneously. For instance, it can display the main View together with expanded detail clones. The FocusedView property can be used to determine which View currently has focus. Setting this property moves focus to the specified View. To specify the focused cell within a View use the ColumnView.FocusedColumn and ColumnView.FocusedRowHandle properties.

The FocusedView property merely indicates the internal grid control’s focus position. To determine whether the grid control is focused read its GridControl.IsFocused property’s value. Whether a particular View has focus can be determined by inspecting the BaseView.IsFocusedView property’s value.

When moving focus between the Views the GridControl.FocusedViewChanged event is raised. When a View receives or loses focus, the BaseView.GotFocus and BaseView.LostFocus events are raised, respectively.

Example

The code below illustrates how to obtain the value of a currently edited cell.

C#

using DevExpress.XtraGrid.Views.Base;

ColumnView view = gridControl1.FocusedView as ColumnView;
string editingValue = null;
if (view != null && view.IsEditing)
    editingValue = view.EditingValue.ToString();

VB.NET

Imports DevExpress.XtraGrid.Views.Base

Dim view As ColumnView = CType(GridControl1.FocusedView, ColumnView)
Dim editingValue As String = Nothing 
If view IsNot Nothing And view.IsEditing Then 
    editingValue = view.EditingValue.ToString()
End If 

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FocusedView property.

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-dashboard-data-inspector-customization/CS/Form1.cs#L23

private void DashboardViewer1_DataInspectorFormClosing(object sender, DataInspectorFormClosingEventArgs e) {
    SaveGridLayout(e.DashboardItemName, e.AggregatedGrid.FocusedView, aggregatedGridLayoutDictionary);
    SaveGridLayout(e.DashboardItemName, e.RawGrid.FocusedView, rawGridLayoutDictionary);

XPO_how-to-use-the-xpo-odata-v3-service-e4389/CS/ODataV3Example/ClientForm.cs#L95

if(ListObjects == null || !(ListObjects[0] is Categories)) return;
ColumnView view = gclODataV3ServiceMain.FocusedView as ColumnView;
if(view.Columns.Count < 1 || view.FocusedRowHandle < 0) return;

how-to-create-a-custom-button-for-the-embeddednavigator-e1127/CS/CustomButton/Form1.cs#L32

if("copy".Equals(e.Button.Tag)) {
    if(gridControl1.FocusedView != null) {
        gridControl1.FocusedView.CopyToClipboard();

how-to-automatically-expand-the-detail-view-when-new-master-row-is-added-e1436/CS/Q205071/Form1.cs#L29

if (e.Button.Tag != null && e.Button.Tag.ToString() == "update") {
    if (gridControl1.FocusedView == gridView1) nwindDataSet.Categories.AcceptChanges();
    else if (gridControl1.FocusedView.ParentView == gridView1) nwindDataSet.Products.AcceptChanges();

how-to-preserve-the-xtragrid-view-state-in-multi-level-master-detail-e1466/CS/RefreshHelperClass.cs#L282

public void SaveState(GridView view) {
    if (ReferenceEquals(view.GridControl.FocusedView, view)) gridState.focused = this;
    SaveExpandedMasterRows(view);

VB.NET

winforms-dashboard-data-inspector-customization/VB/Form1.vb#L24

Private Sub DashboardViewer1_DataInspectorFormClosing(ByVal sender As Object, ByVal e As DataInspectorFormClosingEventArgs)
    SaveGridLayout(e.DashboardItemName, e.AggregatedGrid.FocusedView, aggregatedGridLayoutDictionary)
    SaveGridLayout(e.DashboardItemName, e.RawGrid.FocusedView, rawGridLayoutDictionary)

XPO_how-to-use-the-xpo-odata-v3-service-e4389/VB/ODataV3Example/ClientForm.vb#L103

End If
Dim view As ColumnView = TryCast(gclODataV3ServiceMain.FocusedView, ColumnView)
If view.Columns.Count < 1 OrElse view.FocusedRowHandle < 0 Then

how-to-create-a-custom-button-for-the-embeddednavigator-e1127/VB/CustomButton/Form1.vb#L34

If "copy".Equals(e.Button.Tag) Then
    If gridControl1.FocusedView IsNot Nothing Then
        gridControl1.FocusedView.CopyToClipboard()

how-to-automatically-expand-the-detail-view-when-new-master-row-is-added-e1436/VB/Q205071/Form1.vb#L31

If e.Button.Tag IsNot Nothing AndAlso e.Button.Tag.ToString() = "update" Then
    If gridControl1.FocusedView Is gridView1 Then
        nwindDataSet.Categories.AcceptChanges()

how-to-preserve-the-xtragrid-view-state-in-multi-level-master-detail-e1466/VB/RefreshHelperClass.vb#L304

Public Sub SaveState(ByVal view As GridView)
    If ReferenceEquals(view.GridControl.FocusedView, view) Then
        gridState.focused = Me