ButtonEdit() Constructor

Initializes a new instance of the ButtonEdit class.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v26.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public ButtonEdit()

VB.NET

Public Sub New

Example

The following code snippet creates a ButtonEdit control, customizes its buttons, and places the editor onto the form:

C#

using DevExpress.XtraEditors;
using DevExpress.XtraEditors.Controls;

namespace DXApplication {
    public partial class Form1 : XtraForm {
        public Form1() {
            InitializeComponent();

            // Create a `ButtonEdit` and add it to the form.
            ButtonEdit btnEdit1 = new ButtonEdit() {
                Width = 200
            };

            // Configure the default (first) button as an OK button.
            btnEdit1.Properties.Buttons[0].Kind = ButtonPredefines.OK;

            // Add an additional button and treat it as a Delete action.
            btnEdit1.Properties.Buttons.Add(new EditorButton(ButtonPredefines.Delete));

            // Add the editor to the form's controls collection.
            this.Controls.Add(btnEdit1);

            // Handle button clicks.
            btnEdit1.ButtonClick += BtnEdit1_ButtonClick;
        }
        void BtnEdit1_ButtonClick(object sender, ButtonPressedEventArgs e) {
            ButtonEdit editor = sender as ButtonEdit;
            if (e.Button.Kind == ButtonPredefines.OK) {
                // OK button pressed.
                //...
            }
            if (e.Button.Kind == ButtonPredefines.Delete) {
                // Delete button pressed.
                //...
            }
        }
    }
}

VB.NET

Imports DevExpress.XtraEditors
Imports DevExpress.XtraEditors.Controls

Namespace DXApplication
    Public Partial Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()

            ' Create a ButtonEdit and add it to the form.
            Dim btnEdit1 As New ButtonEdit() With {
                .Width = 200
            }

            ' Configure the default (first) button as an OK button.
            btnEdit1.Properties.Buttons(0).Kind = ButtonPredefines.OK

            ' Add an additional button and treat it as a Delete action.
            btnEdit1.Properties.Buttons.Add(New EditorButton(ButtonPredefines.Delete))

            ' Add the editor to the form's controls collection.
            Me.Controls.Add(btnEdit1)

            ' Handle button clicks.
            AddHandler btnEdit1.ButtonClick, AddressOf BtnEdit1_ButtonClick
        End Sub

        Private Sub BtnEdit1_ButtonClick(sender As Object, e As ButtonPressedEventArgs)
            Dim editor As ButtonEdit = TryCast(sender, ButtonEdit)

            If e.Button.Kind = ButtonPredefines.OK Then
                ' OK button pressed.
                '...
            End If

            If e.Button.Kind = ButtonPredefines.Delete Then
                ' Delete button pressed.
                '...
            End If
        End Sub
    End Class
End Namespace

Related GitHub Examples

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

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.

VB.NET

winforms-custom-buttonedit-display-editvalue-on-button/VB/TestMyButtonEdit/MyButtonEdit.vb#L36

Public Sub New()
    MyBase.New()
End Sub