OptionsColumn.ShowInCustomizationForm Property

Gets or sets whether the column’s header is displayed within the Customization Form when the column is hidden.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
Boolean	**true**	true, if the column’s header is displayed within the Customization Form when the column is hidden; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ShowInCustomizationForm
GridColumn	.OptionsColumn.ShowInCustomizationForm
LayoutViewColumn	.OptionsColumn.ShowInCustomizationForm
BandedGridColumn	.OptionsColumn.ShowInCustomizationForm

Remarks

If the Customization Form is open and you toggle a column’s ShowInCustomizationForm property, you need to manually call the GridView.UpdateColumnsCustomization method to update the form.

Related GitHub Examples

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

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

foreach(GridColumn column in View.Columns) {
    if (column.OptionsColumn.ShowInCustomizationForm) {
        CheckListBox.Items.Add(column, column.GetTextCaption(), column.Visible ? CheckState.Checked : CheckState.Unchecked, true);

how-to-customize-columns-order-and-visibility-in-a-custom-drop-down-menu-e2015/CS/Sample/CustomGridControl.cs#L92

{
    if (col.Visible || col.OptionsColumn.ShowInCustomizationForm)
        hideEdit.Properties.Columns.Add(col.ToString(), col.Visible, col.VisibleIndex, GetColumnHideState(col), GetColumnMoveState(col));

VB.NET

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

For Each column As GridColumn In View.Columns
    If column.OptionsColumn.ShowInCustomizationForm Then
        CheckListBox.Items.Add(column, column.GetTextCaption(),If(column.Visible, CheckState.Checked, CheckState.Unchecked), True)

how-to-customize-columns-order-and-visibility-in-a-custom-drop-down-menu-e2015/VB/Sample/CustomGridControl.vb#L108

For Each col As CustomGridColumn In Columns
    If col.Visible OrElse col.OptionsColumn.ShowInCustomizationForm Then
        hideEdit.Properties.Columns.Add(col.ToString(), col.Visible, col.VisibleIndex, GetColumnHideState(col), GetColumnMoveState(col))