OptionsBand.ShowInCustomizationForm Property

Gets or sets whether the band’s header is displayed within the Customization Form when the band is invisible.

Namespace: DevExpress.XtraGrid.Views.BandedGrid

Assembly: DevExpress.XtraGrid.v19.1.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 band header is displayed within the Customization Form when the band is invisible; otherwise false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ShowInCustomizationForm
GridBand	.OptionsBand.ShowInCustomizationForm

Remarks

End-users can drag the header to the Customization Form to hide the band and drag it back to the band panel to make it visible again.

If the ShowInCustomizationForm option is set to false, they can only drag it onto the Customization Form. The band will disappear and its header will not be displayed within the Customization Form. Thus, end-users will be unable to make it visible again. The band can then only be displayed via code.

Related GitHub Examples

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

how-to-display-bands-and-columns-in-the-same-tree-list-in-the-customization-form-e3723/CS/CustomDescendants/TreeListBandedCustomizationForm.cs#L81

{
    if (!band.Visible && band.OptionsBand.ShowInCustomizationForm)
    {

VB.NET

how-to-display-bands-and-columns-in-the-same-tree-list-in-the-customization-form-e3723/VB/CustomDescendants/TreeListBandedCustomizationForm.vb#L87

For Each band As GridBand In View.Bands
    If (Not band.Visible) AndAlso band.OptionsBand.ShowInCustomizationForm Then
        UnvisibleList.Add(band)