NavigatorCustomButton Class

A custom button within navigator controls.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.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.

Inheritance

Object

NavigatorButtonBase

NavigatorCustomButton