BarManager.OptionsLayout Property

Contains options that control how the bars’ layout is stored to/restored from a stream, xml file or system registry.

Namespace: DevExpress.XtraBars

Assembly: DevExpress.XtraBars.v25.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Options")]
public BarManagerOptionsLayout OptionsLayout { get; }

VB.NET

<DXCategory("Options")>
Public ReadOnly Property OptionsLayout As BarManagerOptionsLayout

Property Value

Type	Description
BarManagerOptionsLayout	An object that provides options that control how the bars’ layout is stored and restored.

Remarks

The following methods save the layout:

• BarManager.SaveLayoutToStream
• BarManager.SaveLayoutToXml
• BarManager.SaveLayoutToRegistry
• BarManager.SaveLayoutToJson

The following methods restore the layout:

• BarManager.RestoreLayoutFromStream
• BarManager.RestoreLayoutFromXml
• BarManager.RestoreLayoutFromRegistry
• BarManager.RestoreLayoutFromJson methods.

The OptionsLayout property provides access to settings that affect loading and saving layouts:

• BarManagerOptionsLayout.AllowAddNewItems - This option affects how the bar layout is restored. If it’s set to true (the default value), items that exist in the current layout, but not in the layout being loaded, are retained. If the option is disabled, these items are destroyed.
• BarManagerOptionsLayout.AllowRemoveOldItems - This option affects how the bar layout is restored. If it’s set to false (the default value), items that exist in the layout being loaded, but not in the current layout, are added to the current layout. If the option is enabled, these items are discarded.
• OptionsLayoutBase.LayoutVersion - Specifies the version of the bar layout.