ChangeLayoutZoneIdArgs Class

Argument class for events raised for layout zone id change.

Inheritance Hierarchy

System.Object
  System.EventArgs
    CMS.Base.CMSEventArgs
      CMS.PortalEngine.ChangeLayoutZoneIdArgs

Namespace: CMS.PortalEngine
Assembly: CMS.PortalEngine (in CMS.PortalEngine.dll) Version: 12.0.0

Syntax

public class ChangeLayoutZoneIdArgs : CMSEventArgs

The ChangeLayoutZoneIdArgs type exposes the following members.

Constructors

	Name	Description
Public method	ChangeLayoutZoneIdArgs

Properties

	Name	Description
Public property	CurrentHandler	Currently executing handler (Inherited from CMSEventArgs.)
Public property	NewZoneId	Gets or sets the new layout zone id.
Public property	OldZoneId	Gets or sets the old layout zone id.
Public property	OriginalEventArgs	Original event arguments for the event (Inherited from CMSEventArgs.)
Public property	PageTemplateId	Gets or sets the page template id where the layout zone is located.
Public property	ZoneWebParts	Gets or sets the layout zone web parts.

Methods

	Name	Description
Public method	CallOnDispose	Adds the given action to the list of actions called when the handler object is disposed (Inherited from CMSEventArgs.)
Public method	CallWhenFinished	Adds the given action to be called when the handler finishes (Inherited from CMSEventArgs.)
Public method	Cancel	Cancels the current handler execution (Inherited from CMSEventArgs.)
Public method	DetectRecursion	Prevents the recursion of the handler execution using the given unique key. The handler won't execute again with the given key until the current execution is finished. Returns true, if recursion is detected and the code shouldn't continue. Otherwise returns false. (Inherited from CMSEventArgs.)
Public method	Dispose	Make sure the objects get disposed (Inherited from CMSEventArgs.)
Public method	Lock	Locks the event on the given lock object. The context stays locked until the handler is disposed. (Inherited from CMSEventArgs.)
Public method	Using	Adds the given object to the list of object that get disposed when the handler object is disposed (Inherited from CMSEventArgs.)