Skip to main content

NavigatorButtonsBase.ButtonCollection Property

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

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

[Browsable(false)]
public NavigatorButtonCollectionBase ButtonCollection { get; }

Property Value

Type Description
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 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.

DataNavigator ctor

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;
}
See Also