Skip to main content

LayoutControl.LayoutUpgrade Event

Occurs when a layout is restored from a data store (a stream, xml file or system registry), and its version differs from the version of the current layout.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v22.2.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.


This event enables you to customize the control’s layout immediately after an earlier version of the layout has been loaded from a data store (a stream, xml file or system registry). To allow the LayoutUpgrade event to be called, you need to assign different versions to different layouts via the LayoutControl.LayoutVersion property.

See Saving and Restoring Layouts to a File, Stream and System Registry for more information.

See Also