Back to Devexpress

SimpleButton.Image Property

windowsforms-devexpress-dot-xtraeditors-dot-simplebutton-a7ba9a5e.md

latest3.4 KB
Original Source

SimpleButton.Image Property

Gets or sets the button’s image.

Namespace : DevExpress.XtraEditors

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[Browsable(false)]
[DefaultValue(null)]
[DXCategory("Appearance")]
[EditorBrowsable(EditorBrowsableState.Never)]
public virtual Image Image { get; set; }
vb
<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
<DefaultValue(Nothing)>
<DXCategory("Appearance")>
Public Overridable Property Image As Image

Property Value

TypeDefaultDescription
Imagenull

The button’s image.

|

Remarks

Use the SimpleButton.ImageOptions property to display an image in a button and specify image-related settings.

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

csharp
simpleButton1.Text = "";
simpleButton1.ImageOptions.Image = Image.FromFile(".\\Stars3_1.png");
simpleButton1.ImageOptions.Location = ImageLocation.MiddleCenter;
vb
simpleButton1.Text = ""
simpleButton1.ImageOptions.Image = Image.FromFile(".\Stars3_1.png")
simpleButton1.ImageOptions.Location = ImageLocation.MiddleCenter

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.

winforms-pictureedit-drag-images-from-windows-explorer/CS/WindowsApplication3/Main.cs#L32

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

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

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

See Also

Text

ImageOptions

SimpleButton Class

SimpleButton Members

DevExpress.XtraEditors Namespace