GridColumn.GetTextCaption() Method

Returns the non formatted column caption.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

public virtual string GetTextCaption()

VB.NET

Public Overridable Function GetTextCaption As String

Returns

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

Remarks

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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

creating-quick-column-customization-popup-window-e991/CS/E991/GridViewQuickColumnCustomization.cs#L197

if (column.OptionsColumn.ShowInCustomizationForm) {
    CheckListBox.Items.Add(column, column.GetTextCaption(), column.Visible ? CheckState.Checked : CheckState.Unchecked, true);
}

how-to-implement-the-accessible-named-grid-row-e552/CS/WindowsApplication210/CGrid.cs#L132

{
    string str = (this.Column.GetTextCaption() == "") ? this.Column.ToolTip : this.Column.GetTextCaption();
    string rowName = ((IAccessibleGrid)this.View).GetRow(((CGridView)this.View).RowHandle2AccessibleIndex(this.RowHandle)).GetName();

gridview-how-to-copy-cells-data-to-clipboard-by-using-the-richeditdocumentserver-t257584/CS/Q577904/Form1.cs#L49

TableCell cell = GetCell(table, 0, i);
srv.Document.InsertText(cell.Range.Start, column.Key.GetTextCaption());
cell.BackgroundColor = Color.Gray;

gridcontrol-how-to-implement-events-for-custom-printing-cells-and-headers-t368970/CS/GridBeforePrint/MyGridViewPrintInfo.cs#L61

var gview = View.OptionsPrint as GridOptionsPrint;
if (gview != null && !gview.AllowMultilineHeaders) return column.GetTextCaption();
return (View as MyGridView).GoAndGetNonFormattedCaption(column.GetCaption());

how-to-draw-a-vertical-caption-in-a-column-header-t142821/CS/MyXtraGrid/Form1.cs#L34

{
    e.Cache.DrawVString(e.Column.GetTextCaption(), e.Appearance.Font, e.Appearance.GetForeBrush(e.Cache), e.Info.CaptionRect, stringFormat, 90);
}

VB.NET

how-to-implement-the-accessible-named-grid-row-e552/VB/WindowsApplication210/CGrid.vb#L144

Dim str As String
If (Me.Column.GetTextCaption() = "") Then
    str = Me.Column.ToolTip

creating-quick-column-customization-popup-window-e991/VB/E991/GridViewQuickColumnCustomization.vb#L248

If column.OptionsColumn.ShowInCustomizationForm Then
    CheckListBox.Items.Add(column, column.GetTextCaption(),If(column.Visible, CheckState.Checked, CheckState.Unchecked), True)
End If

gridview-how-to-copy-cells-data-to-clipboard-by-using-the-richeditdocumentserver-t257584/VB/Q577904/Form1.vb#L50

Dim cell As TableCell = GetCell(table, 0, i)
srv.Document.InsertText(cell.Range.Start, column.Key.GetTextCaption())
cell.BackgroundColor = Color.Gray

gridcontrol-how-to-implement-events-for-custom-printing-cells-and-headers-t368970/VB/GridBeforePrint/MyGridViewPrintInfo.vb#L65

If gview IsNot Nothing AndAlso (Not gview.AllowMultilineHeaders) Then
    Return column.GetTextCaption()
End If

how-to-draw-a-vertical-caption-in-a-column-header-t142821/VB/MyXtraGrid/Form1.vb#L37

If e.Column IsNot Nothing Then
    e.Cache.DrawVString(e.Column.GetTextCaption(), e.Appearance.Font, e.Appearance.GetForeBrush(e.Cache), e.Info.CaptionRect, stringFormat, 90)
End If