Back to Devexpress

NavigatorButtonsBase.ButtonCollection Property

windowsforms-devexpress-dot-xtraeditors-dot-navigatorbuttonsbase-bd5d1f63.md

latest4.1 KB
Original Source

NavigatorButtonsBase.ButtonCollection Property

Provides access to the collection of built-in buttons displayed in the DataNavigator control.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[Browsable(false)]
public NavigatorButtonCollectionBase ButtonCollection { get; }
vb
<Browsable(False)>
Public ReadOnly Property ButtonCollection As NavigatorButtonCollectionBase

Property Value

TypeDescription
NavigatorButtonCollectionBase

A NavigatorButtonCollectionBase object representing the collection of built-in buttons.

|

Remarks

The ButtonCollection property provides access to the control’s built-in button collection. Individual buttons contained within the collection can be accessed using index notation using the NavigatorButtonCollectionBase.Item property.

You can add custom buttons with the NavigatorButtonsBase.CustomButtons collection. The display order of custom buttons can be changed using the NavigatorCustomButton.Index property.

Example

The following code creates a new DataNavigator control, binds it to a data source, and specifies custom images for control buttons at runtime. Custom images are stored in an ImageCollection object.

csharp
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 DataNavigator 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
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 DataNavigator 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

See Also

NavigatorButtonCollectionBase

Item[Int32]

CustomButtons

NavigatorButtonsBase Class

NavigatorButtonsBase Members

DevExpress.XtraEditors Namespace