ColumnView.FocusedColumn Property

Gets or sets the focused column/card field (in CardView and LayoutView Views).

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[Browsable(false)]
public virtual GridColumn FocusedColumn { get; set; }

VB.NET

<Browsable(False)>
Public Overridable Property FocusedColumn As GridColumn

Property Value

Type	Description
GridColumn	A GridColumn object or descendant representing the currently focused column/card field.

Remarks

Use the FocusedColumn property to access the currently focused column/card field , or to set focus to a specific column/card field. When the FocusedColumn property’s value is changed, the ColumnView.FocusedColumnChanged event is raised.

To access the focused row/card, use the ColumnView.FocusedRowHandle property.

After moving focus between cards in LayoutViews and CardViews via the FocusedRowHandle inherited property, the ColumnView.FocusedColumn property is automatically set to null. In this instance, you may want to manually move focus to a specific card field via the FocusedColumn property after changing the FocusedRowHandle.

For more information, see the Columns topic.

Note

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

Example

The example shows how to move focus to a specific column at runtime.

C#

    advBandedGridView1.FocusedColumn = advBandedGridView1.Columns["Country"];

VB.NET

    AdvBandedGridView1.FocusedColumn = AdvBandedGridView1.Columns("Country")

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FocusedColumn 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#

how-to-select-cells-that-are-placed-to-the-right-of-the-current-merged-cell-in-the-same-row-t101418/CS/Sample/Form1.cs#L28

private void gridView1_FocusedRowChanged(object sender, FocusedRowChangedEventArgs e) {
    RefreshRow(e.PrevFocusedRowHandle, gridView1.FocusedColumn);
    RefreshRow(e.FocusedRowHandle, gridView1.FocusedColumn);

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;

how-to-display-buttons-with-different-captions-in-different-rows-of-gridview-e4024/CS/CS/WindowsApplication1/CustomEditor/ButtonEditCustomCaptionHelper.cs#L36

GridView view = sender as GridView;
if (view.FocusedColumn != _Column)
    return;

how-to-edit-multiple-values-in-gridview-at-the-same-time-e2779/CS/MultiSelectionEditingHelper.cs#L35

{
    view.FocusedColumn = hi.Column;
    DXMouseEventArgs.GetMouseArgs(e).Handled = true;

how-to-create-an-advbandedgridview-descendant-allows-using-repositoryitems-to-display-edit-r-e5014/CS/GridView_RowPreview/CustomGridView.cs#L194

{
    get { return base.FocusedColumn; }
    set

VB.NET

how-to-select-cells-that-are-placed-to-the-right-of-the-current-merged-cell-in-the-same-row-t101418/VB/Sample/Form1.vb#L30

Private Sub gridView1_FocusedRowChanged(ByVal sender As Object, ByVal e As FocusedRowChangedEventArgs)
    RefreshRow(e.PrevFocusedRowHandle, gridView1.FocusedColumn)
    RefreshRow(e.FocusedRowHandle, gridView1.FocusedColumn)

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

how-to-display-buttons-with-different-captions-in-different-rows-of-gridview-e4024/VB/WindowsApplication1/CustomEditor/ButtonEditCustomCaptionHelper.vb#L32

Dim view As GridView = TryCast(sender, GridView)
If view.FocusedColumn IsNot _Column Then
    Return

how-to-edit-multiple-values-in-gridview-at-the-same-time-e2779/VB/MultiSelectionEditingHelper.vb#L29

If view.FocusedRowHandle = hi.RowHandle Then
    view.FocusedColumn = hi.Column
    DXMouseEventArgs.GetMouseArgs(e).Handled = True

how-to-create-an-advbandedgridview-descendant-allows-using-repositoryitems-to-display-edit-r-e5014/VB/GridView_RowPreview/CustomGridView.vb#L214

Get
    Return MyBase.FocusedColumn
End Get