Skip to main content
All docs
V24.2

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

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.v24.2.dll

NuGet Package: DevExpress.Win.Navigation

#Declaration

public event LayoutAllowEventHandler BeforeLoadLayout

#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.

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