ColumnViewOptionsBehavior.FocusLeaveOnTab Property

Gets or sets whether pressing the TAB key moves focus to the next control in the tab order, if moving focus via the TAB key within the View is prohibited (or cannot be performed).

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[DefaultValue(false)]
[XtraSerializableProperty]
public virtual bool FocusLeaveOnTab { get; set; }

VB.NET

<DefaultValue(False)>
<XtraSerializableProperty>
Public Overridable Property FocusLeaveOnTab As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true to allow focus to be moved away from the grid control when the TAB key is pressed; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to FocusLeaveOnTab
AdvBandedGridView	.OptionsBehavior.FocusLeaveOnTab
BandedGridView	.OptionsBehavior.FocusLeaveOnTab
ColumnView	.OptionsBehavior.FocusLeaveOnTab
CardView	.OptionsBehavior.FocusLeaveOnTab
GridView	.OptionsBehavior.FocusLeaveOnTab
LayoutView	.OptionsBehavior.FocusLeaveOnTab
TileView	.OptionsBehavior.FocusLeaveOnTab
WinExplorerView	.OptionsBehavior.FocusLeaveOnTab

Remarks

The UseTabKey option (see the GridOptionsNavigation.UseTabKey property in GridViews and the CardOptionsBehavior.UseTabKey property in CardViews) controls focus movement between cells when the TAB key is pressed. If the UseTabKey property is set to true, pressing the TAB key moves focus to the next cell and pressing the SHIFT+TAB key moves focus to the previous cell. By default, when the last cell is focused, pressing the TAB key does nothing. If the FocusLeaveOnTab property is set to true and the last cell is focused, focus will be moved to the next control in the tab order. Similarly, if the FocusLeaveOnTab property is set to true, and the first cell is focused, pressing the SHIFT+TAB key moves focus to the previous control in the tab order.

If the UseTabKey option is set to false and the FocusLeaveOnTab property is set to true, focus is moved away from the grid control when the TAB or SHIFT+TAB key is pressed regardless of the cell being focused.

Note

The FocusLeaveOnTab option is not in effect when focus is within the New Item Row(Card).

The CTRL+TAB and CTRL+SHIFT+TAB keys allow an end-user to move focus away from the grid control. These shortcuts are in effect regardless of any other grid option settings.