GridOptionsView.AllowHtmlDrawHeaders Property

Gets or sets whether HTML formatting can be applied to column and band captions.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[DefaultValue(false)]
[XtraSerializableProperty]
public virtual bool AllowHtmlDrawHeaders { get; set; }

VB.NET

<DefaultValue(False)>
<XtraSerializableProperty>
Public Overridable Property AllowHtmlDrawHeaders As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true if HTML formatting can be applied to column and band captions; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowHtmlDrawHeaders
AdvBandedGridView	.OptionsView.AllowHtmlDrawHeaders
BandedGridView	.OptionsView.AllowHtmlDrawHeaders
GridView	.OptionsView.AllowHtmlDrawHeaders

Remarks

If the AllowHtmlDrawHeaders property is set to true, you can use HTML tags to format the GridColumn.Caption and GridBand.Caption. For detailed information see HTML Text Formatting.

 

Note

• Hints don’t support HTML formatting. They display plain text without tags.

Example

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.

C#

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

VB.NET

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 & ">"

Example

The following example shows how to format the GridBand.Caption using HTML tags. HTML formatting is enabled via the GridOptionsView.AllowHtmlDrawHeaders property. The image below shows the result:

C#

gridBand1.Caption = "Production<br/><b>costs</b>";

bandedGridView1.OptionsView.AllowHtmlDrawHeaders = true;
bandedGridView1.Appearance.HeaderPanel.Options.UseTextOptions = true;
bandedGridView1.Appearance.HeaderPanel.TextOptions.WordWrap = DevExpress.Utils.WordWrap.Wrap; 

VB.NET

gridBand1.Caption = "Production<br/><b>costs</b>"

bandedGridView1.OptionsView.AllowHtmlDrawHeaders = True
bandedGridView1.Appearance.HeaderPanel.Options.UseTextOptions = True
bandedGridView1.Appearance.HeaderPanel.TextOptions.WordWrap = DevExpress.Utils.WordWrap.Wrap

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowHtmlDrawHeaders property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-control-the-grid-column-header-height-by-setting-the-number-of-text-lines-e1490/CS/GridColumnHeight.Module.Win/GridHeaderHeightHelper.cs#L68

{
    gridView.OptionsView.AllowHtmlDrawHeaders = true;
    gridView.Appearance.HeaderPanel.TextOptions.WordWrap = DevExpress.Utils.WordWrap.Wrap;

VB.NET

XAF_how-to-control-the-grid-column-header-height-by-setting-the-number-of-text-lines-e1490/VB/GridColumnHeight.Module.Win/GridHeaderHeightHelper.vb#L60

If gridView IsNot Nothing Then
    gridView.OptionsView.AllowHtmlDrawHeaders = True
    gridView.Appearance.HeaderPanel.TextOptions.WordWrap = DevExpress.Utils.WordWrap.Wrap