TreeList.HtmlImages Property

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

Namespace: DevExpress.XtraTreeList

Assembly: DevExpress.XtraTreeList.v20.1.dll

Declaration

[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:

See HTML Text Formatting for more information.

Examples

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.

TreeList-HtmlImages-ex

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 + ">";
See Also