Skip to main content

BaseView.LayoutUpgrade Event

Occurs after a layout whose version doesn’t match the current layout’s version has been loaded from storage (a stream, xml file or system registry).

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation


public event LayoutUpgradeEventHandler LayoutUpgrade

Event Data

The LayoutUpgrade event's data class is LayoutUpgradeEventArgs. The following properties provide information specific to this event:

Property Description
NewHiddenItems Returns an array of items that exist in the current control but do not exist in the layout being loaded. These items are hidden. This property is in effect for the LayoutControl.
PreviousVersion Returns the textual representation of the previous layout version.


To enable end-users to work with previously saved layouts and ensure that documents from the current layout are still visible after the previous layout has been loaded, you should do the following:

  • When designing a new version of the layout, specify its version using the BaseView.OptionsLayout.LayoutVersion property. Ensure that the version of the new layout differs from the version of the saved layouts.
  • If a previously saved layout whose version does not match the version of the current layout is restored, the LayoutUpgrade event fires. Handle this event to implement a routine that upgrades the previously saved layout. For example, in the event handler you can make specific documents visible.
See Also