NavigatorCustomButtons Class

A collection of custom buttons in navigator controls.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

[ListBindable(false)]
public class NavigatorCustomButtons :
    CollectionBase

VB.NET

<ListBindable(False)>
Public Class NavigatorCustomButtons
    Inherits CollectionBase

Related API Members

The following members accept/return NavigatorCustomButtons objects:

• NavigatorBase.CustomButtons
• NavigatorButtonsBase.CustomButtons

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 NavigatorCustomButtons 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-text-captions-for-the-datanavigator-controls-buttons-e2085/CS/WindowsApplication1/Form1.cs#L64

NavigatorButtonCollectionBase col1 = collection as NavigatorButtonCollectionBase;
NavigatorCustomButtons col2 = collection as NavigatorCustomButtons;
for (int i = 0; i < collection.Count; i++)

VB.NET

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

Dim col1 As NavigatorButtonCollectionBase = TryCast(collection, NavigatorButtonCollectionBase)
Dim col2 As NavigatorCustomButtons = TryCast(collection, NavigatorCustomButtons)
For i As Integer = 0 To collection.Count - 1

Inheritance

Object

CollectionBase

NavigatorCustomButtons