NavigatorButtonsBase.CustomButtons Property

Gets the collection of custom buttons.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public NavigatorCustomButtons CustomButtons { get; }

VB.NET

Public ReadOnly Property CustomButtons As NavigatorCustomButtons

Property Value

Type	Description
NavigatorCustomButtons	A NavigatorCustomButtons object, which is the collection of custom buttons.

Remarks

The CustomButtons property provides access to the collection of custom buttons. Custom buttons can be added to or removed from the collection using the appropriate methods of the collection. Individual buttons can be accessed using indexer notation. The image below shows the data navigator control which contains a custom button.

To access the built-in buttons, use the NavigatorButtonsBase.ButtonCollection property. This property is accessible from the control’s DataNavigator.Buttons or ControlNavigator.Buttons property.

By default, custom buttons are displayed after built-in buttons. To place a custom button at a specific position among the built-in and existing custom buttons, use the NavigatorCustomButton.Index property.

To respond to button clicks, handle the NavigatorBase.ButtonClick event.

Related GitHub Examples

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

DevExpress.XtraEditors.NavigatorCustomButton button;
button = gridControl1.EmbeddedNavigator.Buttons.CustomButtons.Add();
button.Tag = "copy";

how-to-add-text-captions-for-the-datanavigator-controls-buttons-e2085/CS/WindowsApplication1/Form1.cs#L79

    TraverseCollection(SelectedNavigator.Buttons.ButtonCollection);
    TraverseCollection(SelectedNavigator.Buttons.CustomButtons);
}

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

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

VB.NET

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

Dim button As DevExpress.XtraEditors.NavigatorCustomButton
button = gridControl1.EmbeddedNavigator.Buttons.CustomButtons.Add()
button.Tag = "copy"

how-to-add-text-captions-for-the-datanavigator-controls-buttons-e2085/VB/WindowsApplication1/Form1.vb#L84

    TraverseCollection(SelectedNavigator.Buttons.ButtonCollection)
    TraverseCollection(SelectedNavigator.Buttons.CustomButtons)
End Sub

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

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