XtraForm.HtmlImages Property

Gets or sets a collection of images that can be inserted into the form’s caption using the image tag. This property is in effect when the Form Title Bar Skinning feature is enabled.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.Utils.v24.1.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

Declaration

C#

[DefaultValue(null)]
[DXCategory("Appearance")]
public object HtmlImages { get; set; }

VB.NET

<DefaultValue(Nothing)>
<DXCategory("Appearance")>
Public Property HtmlImages As Object

Property Value

Type	Default	Description
Object	null	An image collection (DevExpress.Utils.ImageCollection or DevExpress.Utils.SvgImageCollection).

Remarks

The HTML formatting feature allows you to format the form’s caption using a set of HTML tags. To specify a formatted caption, use the XtraForm.HtmlText property.

When you compose an HTML string, you can use the image tag to insert an image from an image collection and project’s resources into the text.

To insert an image from an image collection, do the following:

• Create an image collection (ImageCollection or SvgImageCollection) and populate it with images.
• Assign the collection to the HtmlImages property.
• When you use the image tag, address a target image by its name (image names can be obtained from the image collection).

C#

this.HtmlImages = imageCollection1;
this.HtmlText = "Person <image=person>";

VB.NET

Me.HtmlImages = imageCollection1
Me.HtmlText = "Person <image=person>"

See HTML Text Formatting to learn more.

To allow text to be formatted using HTML tags, ensure title bar skinning is enabled.