EditorButton(ButtonPredefines, String, Int32, Boolean, Boolean, Boolean, HorzAlignment, Image, KeyShortcut) Constructor

Initializes a new EditorButton instance with the specified property values.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[EditorBrowsable(EditorBrowsableState.Never)]
public EditorButton(
    ButtonPredefines kind,
    string caption,
    int width,
    bool enabled,
    bool visible,
    bool isLeft,
    HorzAlignment imageAlignment,
    Image image,
    KeyShortcut shortcut
)

VB.NET

<EditorBrowsable(EditorBrowsableState.Never)>
Public Sub New(
    kind As ButtonPredefines,
    caption As String,
    width As Integer,
    enabled As Boolean,
    visible As Boolean,
    isLeft As Boolean,
    imageAlignment As HorzAlignment,
    image As Image,
    shortcut As KeyShortcut
)

Parameters

Name	Type	Description
kind	ButtonPredefines	The value to initialize the button’s EditorButton.Kind property.
caption	String	A String value which specifies the button’s caption. This value is assigned to the EditorButton.Caption property.
width	Int32	An integer value specifying the button’s width. This value is assigned to the EditorButton.Width property.
enabled	Boolean	The value to initialize the button’s EditorButton.Enabled property.
visible	Boolean	The value to initialize the button’s EditorButton.Visible property.
isLeft	Boolean	The value to initialize the button’s EditorButton.IsLeft property.
imageAlignment	HorzAlignment	The value to initialize the button’s EditorButton.ImageLocation property.
image	Image	The value to initialize the button’s EditorButton.Image property.
shortcut	KeyShortcut	The value to initialize the button’s EditorButton.Shortcut property.

Remarks

The constructor allows you to create a button with the specified property values. After the button is created, you can add it to the button collection of a ButtonEdit control. For this purpose, use the EditorButtonCollection.Add method accessible via the RepositoryItemButtonEdit.Buttons property.

Example

The following code creates a ButtonEdit control and places it onto a panel:

The code changes the button collection as follows:

• Changes the default button glyph (ellipsis) into (ButtonPredefines.OK).
• Adds a button that displays the glyph (ButtonPredefines.Delete).

The example subscribes to the ButtonEdit.ButtonClick event to respond to button clicks.

C#

ButtonEdit btnEdit1 = new ButtonEdit();
btnEdit1.Width = 100;
btnEdit1.Properties.Buttons[0].Kind = ButtonPredefines.OK;
btnEdit1.Properties.Buttons.Add(new EditorButton(ButtonPredefines.Delete));
panel1.Controls.Add(btnEdit1);

btnEdit1.ButtonClick += BtnEdit1_ButtonClick;

private void BtnEdit1_ButtonClick(object sender, ButtonPressedEventArgs e) {
    ButtonEdit editor = sender as ButtonEdit;
    if(e.Button.Kind == ButtonPredefines.OK) {
        //...
    }
    if (e.Button.Kind == ButtonPredefines.Delete) {
        //...
    }
}

VB.NET

Dim btnEdit1 As ButtonEdit = New ButtonEdit()
btnEdit1.Width = 100
btnEdit1.Properties.Buttons(0).Kind = ButtonPredefines.OK
btnEdit1.Properties.Buttons.Add(New EditorButton(ButtonPredefines.Delete))
Panel1.Controls.Add(btnEdit1)

AddHandler btnEdit1.ButtonClick, AddressOf BtnEdit1_ButtonClick

Private Sub BtnEdit1_ButtonClick(sender As Object, e As ButtonPressedEventArgs)
    Dim editor As ButtonEdit = TryCast(sender, ButtonEdit)
    If e.Button.Kind = ButtonPredefines.OK Then
        '...
    End If
    If e.Button.Kind = ButtonPredefines.Delete Then
        '...
    End If
End Sub