RibbonControl.BeforeLoadLayout Event

Fires before a layout is restored from a storage (a stream, xml file, or the system registry).

Namespace: DevExpress.XtraBars.Ribbon

Assembly: DevExpress.XtraBars.v23.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DXCategory("Events")]
public event LayoutAllowEventHandler BeforeLoadLayout

VB.NET

<DXCategory("Events")>
Public Event BeforeLoadLayout As LayoutAllowEventHandler

Event Data

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

Property	Description
Allow	Gets or sets whether to allow upgrading the control layout.
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. Inherited from LayoutUpgradeEventArgs.
PreviousVersion	Returns the textual representation of the previous layout version. Inherited from LayoutUpgradeEventArgs.

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.