RibbonControl.LayoutUpgrade Event

Fires when a layout is restored from storage (a stream, xml file, or system registry). This event occurs only when layout versions (see the LayoutVersion property) differ.

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v24.2.dll

Declaration

C#

[DXCategory("Events")]
public event LayoutUpgradeEventHandler LayoutUpgrade

VB.NET

<DXCategory("Events")>
Public Event LayoutUpgrade As LayoutUpgradeEventHandler

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.

Remarks

You can use the SaveLayoutToXml and RestoreLayoutFromXml methods to save/restore the layout. Users can use the Customization Form to save/restore the layout.

The BeforeLoadLayout and LayoutUpgrade events fire before and after the layout is restored.