Skip to main content

PivotGridControl.BeforeLoadLayout Event

Occurs before a layout is restored from a storage, allowing you to cancel this action.

Namespace: DevExpress.Xpf.PivotGrid

Assembly: DevExpress.Xpf.PivotGrid.v24.1.dll

NuGet Package: DevExpress.Wpf.PivotGrid


public event PivotLayoutAllowEventHandler BeforeLoadLayout

Event Data

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

Property Description
Allow Gets or sets whether to allow upgrading the control layout.
Handled Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
PreviousVersion Returns the textual representation of the previous layout version. Inherited from PivotLayoutUpgradeEventArgs.
RoutedEvent Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

Method Description
InvokeEventHandler(Delegate, Object) When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object) When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.


The BeforeLoadLayout event allows you to prevent the layout from being restored from a storage (a stream or an XML file) and being applied to the current control.

This event is fired when the PivotGridControl.RestoreLayoutFromStream or PivotGridControl.RestoreLayoutFromXml method is called. To stop the layout from being restored, set the event parameter’s PivotLayoutAllowEventArgs.Allow property to false.

The event parameter’s PivotLayoutUpgradeEventArgs.PreviousVersion property defines the version of the layout being restored. This can be compared with the version of the current layout specified by the DevExpress.Xpf.Core.Serialization.DXSerializer.LayoutVersion attached property value set for the PivotGridControl instance. The layout restoration can be canceled, for example, if the versions do not match.

See Also