ControlNavigator.Buttons Property

Provides access to the navigator’s built-in and custom buttons.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

[DXCategory("Behavior")]
[SmartTagSearchNestedProperties]
public ControlNavigatorButtons Buttons { get; }

VB.NET

<DXCategory("Behavior")>
<SmartTagSearchNestedProperties>
Public ReadOnly Property Buttons As ControlNavigatorButtons

Property Value

Type	Description
ControlNavigatorButtons	A ControlNavigatorButtons object which is the navigator’s buttons.

Remarks

The Buttons property provides access to the navigator’s built-in and custom buttons.

All built-in buttons are stored in the NavigatorButtonsBase.ButtonCollection inherited collection. These buttons can also be accessed individually with the properties exposed by the ControlNavigatorButtons class, e.g., ControlNavigatorButtons.First, ControlNavigatorButtons.Next, ControlNavigatorButtons.Edit, etc.

Custom buttons can be added using the NavigatorButtonsBase.CustomButtons inherited collection. By default, custom buttons are displayed after built-in buttons. To change the display order of custom buttons, use their NavigatorCustomButton.Index properties.

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

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Buttons 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#L22

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

VB.NET

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

AddHandler gridControl1.EmbeddedNavigator.ButtonClick, AddressOf gridControl1_EmbeddedNavigator_ButtonClick
gridControl1.EmbeddedNavigator.Buttons.ImageList = imageCollection1
Dim button As DevExpress.XtraEditors.NavigatorCustomButton