BaseLayoutItem.Visibility Property

Gets or sets whether the layout item is visible within the LayoutControl in regular mode (when layout customization is not performed) and in customization mode.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v19.2.dll

Declaration

C#

[XtraSerializableProperty]
[DefaultValue(LayoutVisibility.Always)]
[DXCategory("Behavior")]
public LayoutVisibility Visibility { get; set; }

VB.NET

<XtraSerializableProperty>
<DefaultValue(LayoutVisibility.Always)>
<DXCategory("Behavior")>
Public Property Visibility As LayoutVisibility

Property Value

Type	Default	Description
LayoutVisibility	**Always**	A LayoutVisibility value.

Available values:

Name	Description
Always	A layout item is visible in regular mode and in customization mode.
Never	A layout item is not visible in regular mode or customization mode.
OnlyInCustomization	A layout item is only visible in customization mode, and hidden in regular mode (when customization is not performed).
OnlyInRuntime	A layout item is only visible in regular mode, and hidden in customization mode.

Remarks

Layout items that are hidden from the LayoutControl using the Visibility property are not accessible via the LayoutControl’s hidden item collection (LayoutControl.HiddenItems) and so they are not listed in the Customization Form.

To hide a layout item at design time and make it accessible via the Customization Form at runtime, drag the item to the Customization Form. To hide a layout item in code and make it accessible via the Customization Form, use the BaseLayoutItem.HideToCustomization method. The BaseLayoutItem.RestoreFromCustomization method allows you to restore the layout item.

A layout item hidden via the Visibility property retains its position within the LayoutControl. This item is collapsed to a 1 pixel-width transparent line. Two or more adjacent hidden items are collapsed to a 2 pixel-width transparent line. When a hidden item’s visibility is restored, it’s displayed at its previous position.

Layout items hidden via the BaseLayoutItem.HideToCustomization method do not retain their positions in the layout.

Related GitHub Examples

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

data-source-wizard-how-to-display-a-list-of-available-tables-after-data-base-selection-t279129/CS/DSWizardQueryTables/ConfigureQueryPageViewEx.cs#L20

InitializeComponent();
layoutItemQueryType.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Never;
layoutItemQuery.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Never;

how-to-add-a-find-panel-similar-to-the-one-provided-by-gridcontrol-to-treelist-e2877/CS/WindowsApplication3/FindPanel.cs#L236

internal void ShowCloseButton(){
    closeItem.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Always;
}

how-to-implement-the-insert-document-field-dialog-winforms-version-t223036/CS/WindowsFormsApplication1/InsertFieldModules/ucPAGENUMBER.cs#L22

    InitializeListBoxItemsNumPages();
    layoutControlItem2.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Never;
}

winforms-designer-how-to-customize-the-data-source-wizard-for-the-olap-data-source-t487352/CS/DataSourceWizardCustomization/Form1.cs#L32

public CustomOlapConnectionParametersControl() : base() {
    lciConnectionType.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Never;
}

VB.NET

data-source-wizard-how-to-display-a-list-of-available-tables-after-data-base-selection-t279129/VB/DSWizardQueryTables/ConfigureQueryPageViewEx.vb#L23

InitializeComponent()
layoutItemQueryType.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Never
layoutItemQuery.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Never

how-to-add-a-find-panel-similar-to-the-one-provided-by-gridcontrol-to-treelist-e2877/VB/WindowsApplication3/FindPanel.vb#L242

Friend Sub ShowCloseButton()
    closeItem.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Always
End Sub

how-to-implement-the-insert-document-field-dialog-winforms-version-t223036/VB/WindowsFormsApplication1/InsertFieldModules/ucPAGENUMBER.vb#L24

    InitializeListBoxItemsNumPages()
    layoutControlItem2.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Never
End If

winforms-designer-how-to-customize-the-data-source-wizard-for-the-olap-data-source-t487352/VB/DataSourceWizardCustomization/Form1.vb#L42

    MyBase.New()
    lciConnectionType.Visibility = DevExpress.XtraLayout.Utils.LayoutVisibility.Never
End Sub