SimpleButton.Image Property

Gets or sets the button’s image.

Namespace: DevExpress.XtraEditors

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	The button’s image.

Remarks

Note

We recommend that you use the ImageOptions.Image property (see SimpleButton.ImageOptions) instead of the Image property to specify image(s) for your buttons. Specifically, the Image property is equivalent to the ImageOptions.Image property (see SimpleButton.ImageOptions).

You can also use the SimpleButton.ImageList and SimpleButton.ImageIndex properties to specify button images. Assign an image collection to the button’s SimpleButton.ImageList property and then use the SimpleButton.ImageIndex property to specify the index of the image to display.

If you specify both the Image and SimpleButton.ImageIndex properties, the button displays the image from the Image property.

The code sample below illustrates how to create a button with an image instead of text.

C#

simpleButton1.Text = "";
simpleButton1.Image = Image.FromFile(".\\Stars3_1.png");
simpleButton1.ImageLocation = ImageLocation.MiddleCenter;

VB.NET

simpleButton1.Text = ""
simpleButton1.Image = Image.FromFile(".\Stars3_1.png")
simpleButton1.ImageLocation = ImageLocation.MiddleCenter

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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-pictureedit-drag-images-from-windows-explorer/CS/WindowsApplication3/Main.cs#L32

    SimpleButton btn = sender as SimpleButton;
    pictureEdit1.DoDragDrop(btn.Image, DragDropEffects.Copy);
}

VB.NET

winforms-pictureedit-drag-images-from-windows-explorer/VB/WindowsApplication3/Main.vb#L27

    Dim btn As SimpleButton = TryCast(sender, SimpleButton)
    pictureEdit1.DoDragDrop(btn.Image, DragDropEffects.Copy)
End Sub