EditorButton.Kind Property

Gets or sets the type of image to display within the button.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

[DefaultValue(ButtonPredefines.Ellipsis)]
public virtual ButtonPredefines Kind { get; set; }

VB.NET

<DefaultValue(ButtonPredefines.Ellipsis)>
Public Overridable Property Kind As ButtonPredefines

Property Value

Type	Default	Description
ButtonPredefines	**Ellipsis**	A ButtonPredefines enumerator value that specifies the type of image to display within the button.

Available values:

Show 22 items

Name	Description
Glyph	A custom bitmap is drawn on the button’s surface.
Down	A Down-arrow is drawn on the button’s surface.
Up	An Up-arrow is drawn on the button’s surface.
Left	A Left-arrow symbol is drawn on the button’s surface.
Right	A Right-arrow is drawn the button’s surface.
Ellipsis	An Ellipsis symbol is drawn on the button’s surface.
Delete	A Delete symbol is drawn on the button’s surface.
OK	An OK sign is drawn on the button’s surface.
Plus	A Plus sign is drawn on the button’s surface.
Minus	A Minus sign is drawn on the button’s surface.
Redo	A Redo symbol is drawn on the button’s surface.
Undo	An Undo symbol is drawn on the button’s surface.
Combo	A Down-arrow for a combo box is drawn on the button’s surface.
SpinUp	An up-arrow for a spin editor is displayed on the button’s surface.
SpinDown	A down-arrow for a spin editor is displayed on the button’s surface.
SpinLeft	A left-arrow for a spin editor is displayed on the button’s surface.
SpinRight	A right-arrow for a spin editor is displayed on the button’s surface.
Close	A Close symbol is displayed on the button’s surface.
DropDown	A Down-arrow is drawn on the button’s surface. Unlike, the Down button, this kind of button allows text to be displayed next to the down-arrow.
Search	A Search symbol is drawn on the button’s surface.
Clear	A Clear symbol is drawn on the button’s surface.
Separator	A Separator.

Remarks

The Kind property allows you to specify the type of image to display within the button. The ButtonPredefines type enumerates possible image types. Setting the Kind property to Glyph allows you to display a custom image specified by the EditorButton.Image property. If Kind is set to a value other than Glyph, the button displays a predefined image. See the ButtonPredefines topic for sample screenshots.

If the Kind property is set to Glyph, Ellipsis, Delete, OK, Plus, Minus, Redo, Undo or DropDown, it is possible to display the button’s EditorButton.Caption near the image. To allow the display of the button’s caption and image at the same time, set the EditorButton.ImageLocation property to any value except for MiddleCenter. Otherwise, only the image is displayed.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Kind property.

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#

custom-editor-how-to-implement-the-windows-explorer-search-editor-e4059/CS/SearchButton/SearchButtonEdit/RepositoryItemSearchButtonEdit.cs#L24

{
    Buttons[ButtonSearchIndex].Kind = ButtonPredefines.Close;
    NullValuePrompt = "Search ...";

how-to-add-custom-buttons-to-tab-page-headers-e4255/CS/XtraTabWithButtons/Form1.cs#L40

    XtraTabPageDescendant xtraPage = sender as XtraTabPageDescendant;
    MessageBox.Show(string.Format("PageName {0}, click on button {1} kind {2}", xtraPage.Name, e.Button.Index, e.Button.Kind));
}

buttonedit-how-to-use-different-images-for-buttons-in-different-states-t538328/CS/ButtonEditImages/Custom Editor/CustomEditorButtonPainter.cs#L30

protected virtual void DrawCustomKindImage(CustomEditorButtonObjectInfoArgs e, Rectangle rect) {
    if (e.Button.Kind == ButtonPredefines.Glyph) {
        Rectangle r = new Rectangle(Point.Empty, e.ImageSize);

how-to-add-a-custom-drawbutton-event-for-buttonedit-e4089/CS/CustomDrawButtonEvent/Form1.cs#L22

private void ConfigureRepositoryItemButtonEdit(RepositoryItemMyButtonEdit item) {
    item.Buttons[0].Kind = ButtonPredefines.OK;
    item.Buttons.Add(new EditorButton());

how-to-add-custom-buttons-to-xtratabcontrols-header-region-e3116/CS/XtraTabControl_CustomButtons/Form1.cs#L22

void xtraTabControl1_CustomHeaderButtonClick(object sender, CustomHeaderButtonEventArgs e) {
    if (e.Button.Kind == ButtonPredefines.Plus)
        OnAddImageBtnClick();

VB.NET

custom-editor-how-to-implement-the-windows-explorer-search-editor-e4059/VB/SearchButton/SearchButtonEdit/RepositoryItemSearchButtonEdit.vb#L22

Public Sub New()
    Buttons(ButtonSearchIndex).Kind = ButtonPredefines.Close
    NullValuePrompt = "Search ..."

how-to-add-custom-buttons-to-tab-page-headers-e4255/VB/XtraTabWithButtons/Form1.vb#L38

    Dim xtraPage As XtraTabPageDescendant = TryCast(sender, XtraTabPageDescendant)
    MessageBox.Show(String.Format("PageName {0}, click on button {1} kind {2}", xtraPage.Name, e.Button.Index, e.Button.Kind))
End Sub

buttonedit-how-to-use-different-images-for-buttons-in-different-states-t538328/VB/ButtonEditImages/Custom Editor/CustomEditorButtonPainter.vb#L30

Protected Overridable Sub DrawCustomKindImage(ByVal e As CustomEditorButtonObjectInfoArgs, ByVal rect As Rectangle)
    If e.Button.Kind = ButtonPredefines.Glyph Then
        Dim r As New Rectangle(Point.Empty, e.ImageSize)

how-to-add-a-custom-drawbutton-event-for-buttonedit-e4089/VB/CustomDrawButtonEvent/Form1.vb#L24

Private Sub ConfigureRepositoryItemButtonEdit(ByVal item As RepositoryItemMyButtonEdit)
    item.Buttons(0).Kind = ButtonPredefines.OK
    item.Buttons.Add(New EditorButton())

how-to-add-custom-buttons-to-xtratabcontrols-header-region-e3116/VB/XtraTabControl_CustomButtons/Form1.vb#L23

Private Sub xtraTabControl1_CustomHeaderButtonClick(ByVal sender As Object, ByVal e As CustomHeaderButtonEventArgs) Handles xtraTabControl1.CustomHeaderButtonClick
    If e.Button.Kind = ButtonPredefines.Plus Then
        OnAddImageBtnClick()