NavigatorButtonClickEventArgs Class

Provides data for the NavigatorBase.ButtonClick event.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

public class NavigatorButtonClickEventArgs :
    EventArgs

VB.NET

Public Class NavigatorButtonClickEventArgs
    Inherits EventArgs

Related API Members

NavigatorButtonClickEventArgs is the data class for the following events:

• NavigatorBase.ButtonClick
• NavigatorButtonBase.Click

Remarks

The NavigatorBase.ButtonClick event is raised each time a user clicks a navigator button. It allows you to override the clicked button’s default action or perform additional actions when buttons are clicked. The NavigatorButtonClickEventArgs class introduces the NavigatorButtonClickEventArgs.Button property which identifies the button clicked. The NavigatorButtonClickEventArgs.Handled property specifies whether the button’s default action is prohibited. It must be set to true to prohibit the clicked button’s default behavior.

NavigatorButtonClickEventArgs objects are automatically created and passed to NavigatorBase.ButtonClick event handlers.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the NavigatorButtonClickEventArgs class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-create-a-custom-button-for-the-embeddednavigator-e1127/CS/CustomButton/Form1.cs#L30

private void gridControl1_EmbeddedNavigator_ButtonClick(object sender, DevExpress.XtraEditors.NavigatorButtonClickEventArgs e) {
    if("copy".Equals(e.Button.Tag)) {

VB.NET

how-to-create-a-custom-button-for-the-embeddednavigator-e1127/VB/CustomButton/Form1.vb#L32

Private Sub gridControl1_EmbeddedNavigator_ButtonClick(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.NavigatorButtonClickEventArgs)
    If "copy".Equals(e.Button.Tag) Then

Inheritance

Object

EventArgs

NavigatorButtonClickEventArgs