BaseView.BeforeLoadLayout Event

Fires when the View attempts to restore a previously saved layout version. Allows you to cancel this restoration.

Namespace : DevExpress.XtraBars.Docking2010.Views

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

C#
VB.NET

csharp

public event LayoutAllowEventHandler BeforeLoadLayout

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 save and load Document layouts with the View’s SaveLayoutTo... / RestoreLayoutFrom... methods (for example, SaveLayoutToXml and RestoreLayoutFromXml). When the RestoreLayoutFrom... method is called, the BeforeLoadLayout event fires. It allows you to check items that are hidden once this layout becomes active (the e.NewHiddenItems property) and the restored layout version (e.PreviousVersion). Based on these properties, you can set the e.Allow propert to false to prevent the View from applying this layout version.

C#
VB.NET

csharp

void TabbedView1_BeforeLoadLayout(object sender, LayoutAllowEventArgs e) {
    TabbedView view = sender as TabbedView;
    if (e.PreviousVersion != view.OptionsLayout.LayoutVersion)
        e.Allow = false;
}

Private Sub TabbedView1_BeforeLoadLayout(ByVal sender As Object, ByVal e As LayoutAllowEventArgs)
    Dim view As TabbedView = TryCast(sender, TabbedView)
    If e.PreviousVersion <> view.OptionsLayout.LayoutVersion Then
        e.Allow = False
    End If
End Sub