DataNavigator.Buttons Property

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

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

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

VB.NET

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

Property Value

Type	Description
DataNavigatorButtons	A DataNavigatorButtons 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 DataNavigatorButtons class, e.g., DataNavigatorButtons.First, DataNavigatorButtons.Next, DataNavigatorButtons.EndEdit, 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.

Example

The following code shows how to create a new DataNavigator control, bind it to a data source and specify custom images for the control’s buttons at runtime. The custom images are stored in an ImageCollection object.

C#

using DevExpress.XtraEditors;

private void CreateDataNavigator() {
    // Create a new DataNavigator control
    DataNavigator dataNavigator = new DataNavigator();
    Controls.Add(dataNavigator);
    dataNavigator.Height = 40;
    dataNavigator.Dock = DockStyle.Bottom;
    // Bind to a data source
    dataNavigator.DataSource = productsBindingSource;
    // Specify the ImageCollection that stores custom images for the DataNavigator's buttons
    dataNavigator.Buttons.ImageList = imageCollection1;
    for (int i = 0; i < dataNavigator.Buttons.ButtonCollection.Count; i++) {
        dataNavigator.Buttons.ButtonCollection[i].ImageIndex = i;
    }
    dataNavigator.ShowToolTips = true;
}

VB.NET

Imports DevExpress.XtraEditors

Private Sub CreateDataNavigator()
   ' Create a new DataNavigator control
   Dim DataNavigator As New DataNavigator()
   Controls.Add(DataNavigator)
   DataNavigator.Dock = DockStyle.Bottom
   dataNavigator.Height = 40
   ' Bind to a data source
   DataNavigator.DataSource = productsBindingSource
   ' Specify the ImageCollection that stores custom images for the DataNavigator's buttons
   DataNavigator.Buttons.ImageList = imageCollection1
   Dim i As Integer
   For i = 0 To DataNavigator.Buttons.ButtonCollection.Count - 1
      DataNavigator.Buttons.ButtonCollection(i).ImageIndex = i
   Next i
   DataNavigator.ShowToolTips = True
End Sub