ControlNavigatorButtons Class

Represents buttons displayed in the ControlNavigator.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

public class ControlNavigatorButtons :
    NavigatorButtonsBase
Public Class ControlNavigatorButtons
    Inherits NavigatorButtonsBase

Related API Members

The following members accept/return ControlNavigatorButtons objects:

Remarks

This class represents ControlNavigator buttons via which a user can navigate through the records in a data source and perform operations on the data. The ControlNavigatorButtons class derives from the NavigatorButtonsBase class and inherits properties and methods common to all buttons used for the above mentioned above purposes. It introduces a set of properties allowing you to access a specific button. You can then customize its look and feel settings as your application needs dictate.

The following image illustrates the navigator's buttons.

ControlNavigatorButtons

In contrast to DataNavigator buttons represented by the DataNavigatorButtons class, ControlNavigatorButtons works directly with a control and this needs to implement the INavigatableControl interface. Methods of this interface provide all necessary default actions. The following table describes each button's functionality.

Button Description
First Sets the current record to the first record in the data source. It is represented by the ControlNavigatorButtons.First property.
PrevPage Changes the current record position in the data source by the count of visible onscreen records backwards. It is represented by the ControlNavigatorButtons.PrevPage property.
Prev Sets the current record to the previous record in the data source. It is represented by the ControlNavigatorButtons.Prev property.
Next Sets the current record to the next record in the data source. It is represented by the ControlNavigatorButtons.Next property.
NextPage Changes the current record position in the data source by the count of visible onscreen records upwards. It is represented by the ControlNavigatorButtons.NextPage property.
Last Sets the current record to the last record in the data source. It is represented by the ControlNavigatorButtons.Last property.
Append Inserts a new record. It is represented by the ControlNavigatorButtons.Append property.
Remove Deletes the current record and focuses the next record. It is represented by the ControlNavigatorButtons.Remove property.
Edit Sets the dataset to an edit state. It is represented by the ControlNavigatorButtons.Edit property.
EndEdit Posts the edited record to the associated data source. It is represented by the ControlNavigatorButtons.EndEdit property.
CancelEdit Cancels edits to the current record. It is represented by the ControlNavigatorButtons.CancelEdit property.

ControlNavigatorButtons objects can be accessed via the ControlNavigator.Buttons property.

Inheritance

Object
NavigatorButtonsBase
ControlNavigatorButtons
See Also