GridColumn.CustomizationCaption Property

Gets or sets the column’s caption when its header is displayed within the Customization Form.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[DXCategory("Appearance")]
[DefaultValue("")]
[XtraSerializableProperty]
public string CustomizationCaption { get; set; }

VB.NET

<DXCategory("Appearance")>
<DefaultValue("")>
<XtraSerializableProperty>
Public Property CustomizationCaption As String

Property Value

Type	Default	Description
String	String.Empty	A String value which specifies the column’s caption when its header is displayed within the Customization Form.

Remarks

The column’s header is displayed within the Customization Form when the column is hidden (its GridColumn.Visible property is set to false) and its OptionsColumn.ShowInCustomizationForm option is set to true. Use the CustomizationCaption property to specify the text which is displayed within the header of the hidden column. Otherwise, if this property isn’t specified, the column’s caption is specified by the GridColumn.Caption property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomizationCaption 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#

how-to-implement-columns-filtering-in-the-column-chooser-e1787/CS/WindowsApplication133/CGrid.cs#L133

{
    string s = col.CustomizationCaption;
    if (string.IsNullOrEmpty(s))

VB.NET

how-to-implement-columns-filtering-in-the-column-chooser-e1787/VB/WindowsApplication133/CGrid.vb#L135

Private Shared Function GetCustomizationCaption(ByVal col As GridColumn) As String
    Dim s As String = col.CustomizationCaption
    If String.IsNullOrEmpty(s) Then