NavigatorCustomButton Class

A custom button within navigator controls.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v20.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public class NavigatorCustomButton :
    NavigatorButtonBase,
    IComparable

VB.NET

Public Class NavigatorCustomButton
    Inherits NavigatorButtonBase
    Implements IComparable

Related API Members

The following members return NavigatorCustomButton objects:

• NavigatorCustomButtons.Add()
• NavigatorCustomButtons.Item[Int32]

Remarks

Navigator controls display a set of built-in buttons (which are used to scroll through the records, post and cancel data changes, insert and delete a record etc.), and they also allow you to display custom buttons that perform custom operations.

To add a custom button, add a NavigatorCustomButton object to the NavigatorButtonsBase.CustomButtons collection.

By default, custom buttons are displayed after the 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 snippet (auto-collected from DevExpress Examples) contains a reference to the NavigatorCustomButton 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-create-a-custom-button-for-the-embeddednavigator-e1127/CS/CustomButton/Form1.cs#L23

gridControl1.EmbeddedNavigator.Buttons.ImageList = imageCollection1;
DevExpress.XtraEditors.NavigatorCustomButton button;
button = gridControl1.EmbeddedNavigator.Buttons.CustomButtons.Add();

VB.NET

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

gridControl1.EmbeddedNavigator.Buttons.ImageList = imageCollection1
Dim button As DevExpress.XtraEditors.NavigatorCustomButton
button = gridControl1.EmbeddedNavigator.Buttons.CustomButtons.Add()

Inheritance

Object

NavigatorButtonBase

NavigatorCustomButton