GroupControl.HtmlImages Property

Gets or sets a collection of images that can be inserted into the control's caption (GroupControl.Text) using the image tag.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.Utils.v20.1.dll

Declaration

[DefaultValue(null)]
[DXCategory("Appearance")]
public virtual object HtmlImages { get; set; }
<DefaultValue(Nothing)>
<DXCategory("Appearance")>
Public Overridable Property HtmlImages As Object

Property Value

Type Default Description
Object

null

An image collection (DevExpress.Utils.ImageCollection or DevExpress.Utils.SvgImageCollection).

Remarks

Enable the GroupControl.AllowHtmlText property to use a set of HTML-inspired tags to format the display text of the control's caption (GroupControl.Text).

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).
groupControl1.AllowHtmlText = true;
groupControl1.HtmlImages = imageCollection1;
groupControl1.Text = "Settings <image=settings.png>";

See HTML Text Formatting to learn more.

See Also