Skip to main content

ASPxPivotGrid.BeforeLoadLayout Event

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

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.v23.2.dll

NuGet Package: DevExpress.Web


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.


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

This event is fired when an attempt is made to restore a layout using the ASPxPivotGrid.LoadLayoutFromStream or ASPxPivotGrid.LoadLayoutFromString method. To stop the layout from being restored, set the event parameter’s LayoutAllowEventArgs.Allow property to false.

The event parameter’s LayoutUpgradeEventArgs.PreviousVersion property defines the version of the layout being restored. This can be compared with the version of the current layout specified by the OptionsLayoutBase.LayoutVersion property of the ASPxPivotGrid.OptionsLayout object. The layout restoration can be canceled, for example, if the versions do not match.

See Also