ControlNavigator Class

Provides a graphical interface for navigating data-aware controls that implement the INavigatableControl interface (this interface is implemented by all DevExpress data-aware container controls).

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

[SmartTagAction(typeof(ControlNavigatorButtonsActions), "CustomButtons", "Custom Buttons", SmartTagActionType.CloseAfterExecute)]
[ToolboxBitmap(typeof(ToolboxIconsRootNS), "ControlNavigator")]
public class ControlNavigator :
    NavigatorBase,
    IGetNavigatableControl

<SmartTagAction(GetType(ControlNavigatorButtonsActions), "CustomButtons", "Custom Buttons", SmartTagActionType.CloseAfterExecute)>
<ToolboxBitmap(GetType(ToolboxIconsRootNS), "ControlNavigator")>
Public Class ControlNavigator
    Inherits NavigatorBase
    Implements IGetNavigatableControl

The following members return ControlNavigator objects:

Remarks

The ControlNavigator allows an end-user to manipulate records in an external data-aware control. It is derived from the NavigatorBase class, and so it inherits properties and methods common to all data navigation controls.

DataNavigator

The ControlNavigator displays built-in buttons that enable a user to scroll forward or backward through records one at a time, go to the first record, go to the last record, insert a new record, post data changes, cancel data changes and delete a record. You can also add custom buttons, when required. To access built-in and custom buttons, use the DataNavigator.Buttons property. To perform custom actions on button clicks, handle the NavigatorBase.ButtonClick event.

For the ControlNavigator to manipulate records in an external control, this external control must implement the DevExpress.XtraEditors.INavigatableControl interface. This interface is implemented by the GridControl, TreeList and VGridControl classes. Use the ControlNavigator.NavigatableControl property to bind such a control to the ControlNavigator.

The ControlNavigator can display a text string that specifies the current record and the total record count in the bound control. Use the NavigatorBase.TextLocation and NavigatorBase.TextStringFormat to customize the display of this text.

The GridControl supports an embedded data navigator, which can be enabled with the GridControl.UseEmbeddedNavigator property. This embedded navigator’s functionality is equivalent to the functionality of the ControlNavigator. So, you can choose to use either the embedded navigator or an external ControlNavigator.