SchedulerControl.BeforeLoadLayout Event

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

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v20.1.dll

Declaration

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

The BeforeLoadLayout event allows you to prevent the layout from being restored and applied to the control.

This event is fired when an attempt is made to restore a layout from storage using one of the following methods: SchedulerControl.RestoreLayoutFromRegistry, SchedulerControl.RestoreLayoutFromStream and SchedulerControl.RestoreLayoutFromXml. To cancel the process, set the event's Allow parameter to false.

See Also