ButtonEdit Class

The text editor that supports built-in buttons in the edit box.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v20.1.dll

Declaration

public class ButtonEdit :
    TextEdit
Public Class ButtonEdit
    Inherits TextEdit

Related API Members

The following members accept/return ButtonEdit objects:

Remarks

ButtonEdit editors are text editors which allow you to display an unlimited number of buttons in the edit box.

ButtonEdit

The ButtonEdit class overrides the ButtonEdit.Properties property to return a RepositoryItemButtonEdit object. You should use this object's RepositoryItemButtonEdit.Buttons property to access the collection of buttons displayed in the editor. Each button is represented by an EditorButton object that provides a number of properties specifying the button's appearance, shortcut, visibility, hint text, etc.

Handle the RepositoryItemButtonEdit.ButtonClick and RepositoryItemButtonEdit.ButtonPressed events to respond to clicking editor buttons.

Editor buttons use the paint style specified by the RepositoryItemButtonEdit.ButtonsStyle property.

Examples

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:

ButtonEdit1_creating_example.gif

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