BaseLayoutItem.HideToCustomization() Method

Hides the item.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v19.2.dll

Declaration

C#

public virtual void HideToCustomization()

VB.NET

Public Overridable Sub HideToCustomization

Remarks

This method hides the layout item. The item can then be accessed via the Customization Form. To display a hidden item within the layout control, use the BaseLayoutItem.RestoreFromCustomization method.

To access the hidden items, use the LayoutControl.HiddenItems property.

Example

The code below handles the LayoutGroup.CustomButtonClick event to hide the layout group with a click on a button in its header. To add buttons to the header, use the CustomHeaderButtons collection.

C#

private void layoutControlGroup1_CustomButtonClick(object sender, DevExpress.XtraBars.Docking2010.BaseButtonEventArgs e) {
    LayoutControlGroup layoutGroup = sender as LayoutControlGroup;
    if (e.Button.Properties.Caption == "Hide")
        layoutGroup.HideToCustomization();
}

VB.NET

Private Sub layoutControlGroup1_CustomButtonClick(ByVal sender As Object, ByVal e As DevExpress.XtraBars.Docking2010.BaseButtonEventArgs) _
    Handles layoutControlGroup1.CustomButtonClick
    Dim layoutGroup As LayoutControlGroup = TryCast(sender, LayoutControlGroup)
    If e.Button.Properties.Caption = "Hide" Then
        layoutGroup.HideToCustomization()
    End If
End Sub

Related GitHub Examples

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

how-to-show-the-confirmation-dialog-before-hiding-a-layout-item-in-the-customization-form-e3592/CS/WindowsApplication3/Custom LayoutControl/MyLayoutControlItem.cs#L19

    if (args.CanHideItem)
        base.HideToCustomization();
}

VB.NET

how-to-show-the-confirmation-dialog-before-hiding-a-layout-item-in-the-customization-form-e3592/VB/WindowsApplication3/Custom LayoutControl/MyLayoutControlItem.vb#L25

If args.CanHideLayoutItem Then
    MyBase.HideToCustomization()
End If