GridControl.EmbeddedNavigator Property

Provides access to the embedded data navigator.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[DXCategory("Appearance")]
public virtual ControlNavigator EmbeddedNavigator { get; }

VB.NET

<DXCategory("Appearance")>
Public Overridable ReadOnly Property EmbeddedNavigator As ControlNavigator

Property Value

Type	Description
ControlNavigator	A ControlNavigator descendant representing the grid control’s embedded data navigator.

Remarks

When the GridControl.UseEmbeddedNavigator property value is true, the grid control displays a data navigator at the bottom. The EmbeddedNavigator property provides access to this navigator’s settings. Using this property, you can control a buttons’ visibility, change its appearance and hint texts, etc.

You can also enable/disable the navigator’s Append and Delete buttons via the ColumnViewOptionsBehavior.AllowAddRows and ColumnViewOptionsBehavior.AllowDeleteRows options.

The enabled state of specific buttons (e.g., EndEdit and CancelEdit) is controlled automatically and cannot be changed using the button’s Enabled property. For instance, the EndEdit button, which is used to post the edited value, is automatically activated when an end user activates an editor in the grid, and is deactivated when the cell editor closes.

Note that you can also link an external ControlNavigator to the grid control. Just place a ControlNavigator control onto the form and bind it to your grid using its ControlNavigator.NavigatableControl property.

Please refer to the Using Navigators topic, for additional information.

Example

In this example we change the visibility of two buttons of the embedded navigator: Append and Remove.

C#

    ControlNavigator navigator = gridControl1.EmbeddedNavigator;
    navigator.Buttons.BeginUpdate();
    try {
        navigator.Buttons.Append.Visible = false;
        navigator.Buttons.Remove.Visible = false;
    }
    finally {
        navigator.Buttons.EndUpdate();
    }

VB.NET

    Dim navigator As ControlNavigator = GridControl1.EmbeddedNavigator
    navigator.Buttons.BeginUpdate()
    Try
        navigator.Buttons.Append.Visible = False
        navigator.Buttons.Remove.Visible = False
    Finally
        navigator.Buttons.EndUpdate()
    End Try

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the EmbeddedNavigator 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-create-a-custom-button-for-the-embeddednavigator-e1127/CS/CustomButton/Form1.cs#L21

gridControl1.UseEmbeddedNavigator = true;
gridControl1.EmbeddedNavigator.ButtonClick += new DevExpress.XtraEditors.NavigatorButtonClickEventHandler(gridControl1_EmbeddedNavigator_ButtonClick);
gridControl1.EmbeddedNavigator.Buttons.ImageList = imageCollection1;

custom-gridcontrol-how-to-create-a-vertical-embedded-navigator-e4091/CS/ExtendedDataNavigator/CustomGridControl/CustomGridViewInfo.cs#L30

{
    return (View.GridControl.EmbeddedNavigator != null)
        && (View.GridControl.UseEmbeddedNavigator)

VB.NET

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

gridControl1.UseEmbeddedNavigator = True
AddHandler gridControl1.EmbeddedNavigator.ButtonClick, AddressOf gridControl1_EmbeddedNavigator_ButtonClick
gridControl1.EmbeddedNavigator.Buttons.ImageList = imageCollection1

custom-gridcontrol-how-to-create-a-vertical-embedded-navigator-e4091/VB/ExtendedDataNavigator/CustomGridControl/CustomGridViewInfo.vb#L26

Private Function IsBaseCalcClientRect() As Boolean
    Return (View.GridControl.EmbeddedNavigator IsNot Nothing) AndAlso (View.GridControl.UseEmbeddedNavigator) AndAlso ((TryCast(View.GridControl.EmbeddedNavigator, ExtendedDataNavigator)).NavigatorOrientation = NavigatorOrientation.Vertical)
End Function