NavigatorButtonsBase Class

Serves as the base for DataNavigatorButtons and ControlNavigatorButtons classes.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

public abstract class NavigatorButtonsBase :
    IImageCollectionHelper

VB.NET

Public MustInherit Class NavigatorButtonsBase
    Implements IImageCollectionHelper

Remarks

The NavigatorButtonsBase class serves as the base for classes that provide access to button settings displayed by navigator controls (DataNavigator and ControlNavigator). Properties provided by this class allow you to specify the source of images to be displayed in buttons, the number of records by which the PrevPage and NextPage buttons navigate. The NavigatorButtonsBase.ButtonCollection property provides access to the navigator’s button collection. Individual buttons in this case can be accessed using indexer notation.

Descendants of the NavigatorButtonBase class provide properties containing settings for each individual button. These descendants can be accessed via the ControlNavigator.Buttons and DataNavigator.Buttons properties.

Related GitHub Examples

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

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-add-a-custom-button-to-the-grids-embedded-navigator-e727/CS/MyEmbeddedNavigator.cs#L21

public MyEmbeddedNavigator(GridControl control) : base(control) {}
protected override NavigatorButtonsBase CreateButtons() {
    return new MyNavigatorButtons(this);

datanavigator-how-to-change-the-order-of-buttons-e5031/CS/WindowsFormsApplication21/CustomDataNavigatorButtonCollection.cs#L13

}
protected override void CreateButtons(NavigatorButtonsBase buttons) {
    AddButton(new DataNavigatorFirstButtonHelper(buttons));

how-to-manually-format-text-displayed-in-the-datanavigator-e3054/CS/WindowsApplication1/Custom DataNavigator/MyNavigatorButtonsViewInfo.cs#L9

{
    public MyNavigatorButtonsViewInfo(NavigatorButtonsBase buttons)
        : base(buttons)

custom-gridcontrol-how-to-create-a-vertical-embedded-navigator-e4091/CS/ExtendedDataNavigator/Navigator/ExtendedDataNavigatorButtonsViewInfo.cs#L13

{
    public ExtendedDataNavigatorButtonsViewInfo(NavigatorButtonsBase buttons)
        : base(buttons) {}

how-to-show-the-popup-menu-when-clicking-the-custom-button-of-the-controlnavigator-e1184/CS/Form1.cs#L21

if (e.Button == navigator.Buttons.CustomButtons[0]) {
    FieldInfo fi = typeof(NavigatorButtonsBase).GetField("viewInfo", BindingFlags.Instance | BindingFlags.NonPublic);
    NavigatorButtonsViewInfo buttonsViewInfo = (NavigatorButtonsViewInfo)fi.GetValue(navigator.ViewInfo.Buttons);

VB.NET

how-to-add-a-custom-button-to-the-grids-embedded-navigator-e727/VB/MyEmbeddedNavigator.vb#L26

End Sub
Protected Overrides Function CreateButtons() As NavigatorButtonsBase
    Return New MyNavigatorButtons(Me)

datanavigator-how-to-change-the-order-of-buttons-e5031/VB/WindowsFormsApplication21/CustomDataNavigatorButtonCollection.vb#L15

End Sub
Protected Overrides Sub CreateButtons(ByVal buttons As NavigatorButtonsBase)
    AddButton(New DataNavigatorFirstButtonHelper(buttons))

how-to-manually-format-text-displayed-in-the-datanavigator-e3054/VB/WindowsApplication1/Custom DataNavigator/MyNavigatorButtonsViewInfo.vb#L9

Inherits NavigatorButtonsViewInfo
Public Sub New(ByVal buttons As NavigatorButtonsBase)
    MyBase.New(buttons)

custom-gridcontrol-how-to-create-a-vertical-embedded-navigator-e4091/VB/ExtendedDataNavigator/Navigator/ExtendedDataNavigatorButtonsViewInfo.vb#L13

Public Sub New(ByVal buttons As NavigatorButtonsBase)
    MyBase.New(buttons)

how-to-show-the-popup-menu-when-clicking-the-custom-button-of-the-controlnavigator-e1184/VB/Form1.vb#L23

If e.Button Is navigator.Buttons.CustomButtons(0) Then
    Dim fi As FieldInfo = GetType(NavigatorButtonsBase).GetField("viewInfo", BindingFlags.Instance Or BindingFlags.NonPublic)
    Dim buttonsViewInfo As NavigatorButtonsViewInfo = DirectCast(fi.GetValue(navigator.ViewInfo.Buttons), NavigatorButtonsViewInfo)

Inheritance

Object

NavigatorButtonsBase

ControlNavigatorButtons

DataNavigatorButtons