BaseView.HtmlImages Property

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

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.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

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

The GridOptionsView.AllowHtmlDrawHeaders and GridOptionsView.AllowHtmlDrawGroups properties activate HTML formatting for column/band headers and group rows. To format cell text with HTML tags, use RepositoryItemHypertextLabel.

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 Customer column's caption using HTML tags. The HTML formatting feature is enabled via the GridOptionsView.AllowHtmlDrawHeaders property.

HtmlImages-In-ColumnHeader

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

gridView1.OptionsView.AllowHtmlDrawHeaders = true;
gridView1.HtmlImages = imageCollection1;
columnCustomer.Caption = columnCustomer.GetCaption() + "<image=" + imageName + ">";
See Also