EditorButton Class

Represent an individual editor button displayed in a ButtonEdit control or descendant.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public class EditorButton :
    IDisposable,
    ICaptionSupport,
    ISupportCommandBinding

VB.NET

Public Class EditorButton
    Implements IDisposable,
               ICaptionSupport,
               ISupportCommandBinding

Related API Members

The following members return EditorButton objects:

• ButtonPressedEventArgs.Button
• EditorButtonCollection.Item[Int32]

Remarks

The ButtonEdit editor and all editors derived from it allow you to display an unlimited number of buttons within the editor box. The collection of buttons displayed by an editor is available via the RepositoryItemButtonEdit.Buttons property. This property provides access to a collection object whose members can be used to add, delete and access individual buttons. Each individual button is represented by an EditorButton object. Such objects provide a number of settings specifying the button’s appearance, associated shortcut, visibility, tooltip, etc.

Note: editor buttons do not provide their own events allowing you to handle button clicks. To respond to clicking or pressing an editor button, you should handle the RepositoryItemButtonEdit.ButtonClick and RepositoryItemButtonEdit.ButtonPressed events respectively. These events provide an EditorButton object as the parameter which can be used to identify which button was affected.

Example

The following code creates a button edit control and places it onto a panel1 panel. The code changes default button kind (ellipsis) into ButtonPredefines.OK and adds another button (ButtonPredefines.Delete) to the button’s collection.

The result of code execution is displayed below:

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);

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)

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the EditorButton 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-customize-dialog-forms-in-xtrarichedit-suite-e3095/CS/CustomDialogs/MyFontForm.cs#L97

this.fontEdit1.Properties.AccessibleRole = System.Windows.Forms.AccessibleRole.ComboBox;
this.fontEdit1.Properties.Buttons.AddRange(new DevExpress.XtraEditors.Controls.EditorButton[] {
new DevExpress.XtraEditors.Controls.EditorButton(DevExpress.XtraEditors.Controls.ButtonPredefines.Combo)});

VB.NET

how-to-customize-dialog-forms-in-xtrarichedit-suite-e3095/VB/CustomDialogs/MyFontForm.vb#L96

Me.fontEdit1.Properties.AccessibleRole = System.Windows.Forms.AccessibleRole.ComboBox
Me.fontEdit1.Properties.Buttons.AddRange(New DevExpress.XtraEditors.Controls.EditorButton() { New DevExpress.XtraEditors.Controls.EditorButton(DevExpress.XtraEditors.Controls.ButtonPredefines.Combo)})
Me.fontEdit1.Size = New System.Drawing.Size(200, 20)

Inheritance

Object

EditorButton

CustomHeaderButton