EditorButton.Image Property

Gets or sets a custom image to display on the button.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[Browsable(false)]
[DefaultValue(null)]
[DXCategory("Appearance")]
[EditorBrowsable(EditorBrowsableState.Never)]
public virtual Image Image { get; set; }

VB.NET

<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
<DefaultValue(Nothing)>
<DXCategory("Appearance")>
Public Overridable Property Image As Image

Property Value

Type	Default	Description
Image	null	A Image object that specifies the image displayed on the button surface.

Remarks

A button can display either a custom image or predefined glyphs. The custom image is displayed if the button’s kind specified by the EditorButton.Kind property is set to ButtonPredefines.Glyph. Otherwise, the button displays a predefined image depending upon the current value of the EditorButton.Kind property.

You can display a caption near the button’s image. For this purpose, set the EditorButton.Caption property. To align the image relative to the button’s caption, use EditorButton.ImageLocation.

When the Image property value is changed, the button’s EditorButton.Changed event is fired.

The Image property is equivalent to the ImageOptions.Image property (see EditorButton.ImageOptions).

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Image 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#

winforms-create-data-bound-imagecombobox/CS/Form1.cs#L61

    button.Visible = !(selectedImage == null);
    button.Image = selectedImage;
}

gridview-how-to-add-a-custom-button-to-the-filterpanel-t375271/CS/Form1.cs#L29

b = new EditorButton(ButtonPredefines.Glyph) { Caption = "Custom Filter Button", Width = 125 };
b.Image = Image.FromFile(Directory.GetParent(Directory.GetCurrentDirectory()).Parent.FullName + @"\Filter_16x16.png");
b.ImageLocation = DevExpress.XtraEditors.ImageLocation.MiddleLeft;

VB.NET

winforms-create-data-bound-imagecombobox/VB/Form1.vb#L52

    button.Visible = Not selectedImage Is Nothing
    button.Image = selectedImage
End Sub

gridview-how-to-add-a-custom-button-to-the-filterpanel-t375271/VB/Form1.vb#L27

b = New EditorButton(ButtonPredefines.Glyph) With {.Caption = "Custom Filter Button", .Width = 125}
b.Image = Image.FromFile(Directory.GetParent(Directory.GetCurrentDirectory()).Parent.FullName & "\Filter_16x16.png")
b.ImageLocation = DevExpress.XtraEditors.ImageLocation.MiddleLeft