TreeList.HtmlImages Property

Gets or sets a collection of images that can be embedded in column/band headers and cells using the image tag.

Assembly : DevExpress.XtraTreeList.v25.2.dll

NuGet Packages : DevExpress.Win.Navigation, DevExpress.Win.TreeList

Declaration

C#
VB.NET

csharp

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

<DefaultValue(Nothing)>
Public Property HtmlImages As Object

Property Value

Type	Default	Description
Object	null

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

Remarks

You can use a set of HTML-inspired tags to format text in column/band headers and cells.

The TreeListOptionsView.AllowHtmlDrawHeaders property activates HTML formatting for column/band headers. To format cell text with HTML tags, use a RepositoryItemHypertextLabel as an in-place editor.

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 display images in cells with RepositoryItemHypertextLabel, you can also assign the created image collection to the RepositoryItemHypertextLabel.HtmlImages property.
When you use the image tag, address a target image by its name (image names can be obtained from the image collection).

See HTML Text Formatting for more information.

Example

The following example shows how to display an image to the right of the Job Title column’s caption using HTML tags. The HTML formatting feature is enabled via the TreeListOptionsView.AllowHtmlDrawHeaders property.

C#
VB.NET

csharp

string imageName = "customer";
imageCollection1.AddImage(Image.FromFile("c:\\customer-16x16.png"), imageName);

treeList1.OptionsView.AllowHtmlDrawHeaders = true;
treeList1.HtmlImages = imageCollection1;
colJobTitle.Caption = colJobTitle.GetCaption() + "<image=" + imageName + ">";

Dim imageName As String = "customer"
imageCollection1.AddImage(Image.FromFile("c:\customer-16x16.png"), imageName)

gridView1.OptionsView.AllowHtmlDrawHeaders = True
gridView1.HtmlImages = imageCollection1
columnCustomer.Caption = columnCustomer.GetCaption() & "<image=" & imageName & ">"