GridBand.GetTextCaption() Method

Returns the non formatted band caption.

Namespace: DevExpress.XtraGrid.Views.BandedGrid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

public string GetTextCaption()

VB.NET

Public Function GetTextCaption As String

Returns

Type	Description
String	A string value that represents the band’s non formatted caption.

Remarks

If the GridOptionsView.AllowHtmlDrawHeaders option is enabled, you can use HTML tags to format band captions. In this instance, the GetTextCaption method returns the band’s non formatted caption (plain text without tags).

Related GitHub Examples

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

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#

bandedgridview-how-to-export-certain-column-captions-vertically-t184820/CS/CustomBandedGridView/CustomBandedGridView.cs#L66

}
var brick = DrawTextBrick(graph, band.Band.GetTextCaption(), r);
brick.Style = (BrickStyle)brick.Style.Clone();

VB.NET

bandedgridview-how-to-export-certain-column-captions-vertically-t184820/VB/CustomBandedGridView/CustomBandedGridView.vb#L76

End If
Dim brick = DrawTextBrick(graph, band.Band.GetTextCaption(), r)
brick.Style = DirectCast(brick.Style.Clone(), BrickStyle)