XtraForm.IconOptions Property

Provides access to image settings that allow you to assign raster and vector images to XtraForms (instead of traditional .ico images).

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.Utils.v24.2.dll

Declaration

C#

[DXCategory("Appearance")]
public FormIconOptions IconOptions { get; }

VB.NET

<DXCategory("Appearance")>
Public ReadOnly Property IconOptions As FormIconOptions

Property Value

Type	Description
DevExpress.XtraEditors.FormIconOptions	Provides access to form icon-related settings.

Remarks

Use this property to set up vector or raster image for this form instance.

C#

this.IconOptions.SvgImage = Properties.Resources.barcodeImage;

VB.NET

Me.IconOptions.SvgImage = My.Resources.barcodeImage

Note that images assigned through the IconOptions object (IconOptions.Image, IconOptions.SvgImage, IconOptions.ImageURI) have priority over the standard Icon property.

A forms icon size is fixed, you cannot use the IconOptions.SvgImageSize property to change this size.

If you need to set up the same image for all DevExpress forms in your application, use the static FormIconOptions.Default property.

C#

using DevExpress.XtraEditors;

FormIconOptions.Default.SvgImage = Properties.Resources.avocado;

VB.NET

Imports DevExpress.XtraEditors

FormIconOptions.Default.SvgImage = My.Resources.avocado

Note

Use the IconOptions.Image and IconOptions.LargeImage properties to assign raster images with different resolutions to the XtraForm (to avoid blurring). The Image property specifies the image displayed in the title bar. The LargeImage property specifies the image displayed in the taskbar.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the IconOptions 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-memo-editor-advanced-mode/CS/MemoEditSample/Views/SettingsView.cs#L15

service.FormStyle = (form) => {
    ((XtraForm)form).IconOptions.Assign(this.IconOptions);
    form.FormBorderStyle = FormBorderStyle.FixedToolWindow;

VB.NET

winforms-memo-editor-advanced-mode/VB/MemoEditSample/Views/SettingsView.vb#L18

service.FormStyle = Sub(form)
    CType(form, XtraForm).IconOptions.Assign(Me.IconOptions)
    form.FormBorderStyle = FormBorderStyle.FixedToolWindow