OptionsColumn.ShowCaption Property

Gets or sets whether the column’s caption is displayed within the column header.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v23.2.dll

NuGet Packages: DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

C#

[DefaultValue(true)]
[XtraSerializableProperty]
public bool ShowCaption { get; set; }

VB.NET

<DefaultValue(True)>
<XtraSerializableProperty>
Public Property ShowCaption As Boolean

Property Value

Type	Default	Description
Boolean	true	true if the column’s caption is displayed within the column header; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ShowCaption
GridColumn	.OptionsColumn .ShowCaption

Remarks

Hiding the column’s caption can be useful when you want the column header to display only an icon (without any text). An icon for the column header can be specified via the GridColumn.ImageIndex property.

Related GitHub Examples

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

winforms-grid-custom-print-cells-headers-in-print-preview/CS/GridBeforePrint/MyGridViewPrintInfo.cs#L36

string caption = GetTextCaptionForPrinting(col.Column);
if (!col.Column.OptionsColumn.ShowCaption) caption = string.Empty;
ITextBrick itb = DrawTextBrick(graph, caption, r);

winforms-grid-multiple-row-selection-web-style-checkboxes/CS/E1271/CheckMarkSelection.cs#L122

column.Caption = "Mark";
column.OptionsColumn.ShowCaption = false;
column.OptionsColumn.AllowEdit = false;

VB.NET

winforms-grid-custom-print-cells-headers-in-print-preview/VB/GridBeforePrint/MyGridViewPrintInfo.vb#L37

Dim caption As String = GetTextCaptionForPrinting(col.Column)
If Not col.Column.OptionsColumn.ShowCaption Then
    caption = String.Empty

winforms-grid-multiple-row-selection-web-style-checkboxes/VB/E1271/CheckMarkSelection.vb#L151

column.Caption = "Mark"
column.OptionsColumn.ShowCaption = False
column.OptionsColumn.AllowEdit = False