NavigatorBase Class

Serves as a base for DataNavigator and ControlNavigator classes.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

public abstract class NavigatorBase :
    BaseStyleControl,
    INavigatorOwner
Public MustInherit Class NavigatorBase
    Inherits BaseStyleControl
    Implements INavigatorOwner

Remarks

The NavigatorBase class is abstract and cannot be used directly. It serves as a base for (db and non-db) navigators used to move through the records in a dataset and perform operations against the data.

The NavigatorBase.TabStop property allows you to specify whether the navigator can be focused using the TAB key. The navigator button's look is specified by the NavigatorBase.ButtonStyle property.

Navigators can display button hints. This behavior is controlled by the NavigatorBase.ShowToolTips property. The BaseControl.ToolTipController property, in turn, enables you to specify the ToolTipController component used to control the navigator button's hint (appearance and behavior).

Examples

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