AbstractAdvancedHandler Class

Base class for advanced handler classes

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractHandler
    CMS.Base.AbstractAdvancedHandler
      CMS.Base.AdvancedHandler<THandler, TArgs>

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 13.0.131

Syntax

public abstract class AbstractAdvancedHandler : AbstractHandler

The AbstractAdvancedHandler type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractAdvancedHandler

Properties

	Name	Description
Protected property	Continue	Specifies whether the context of execution should continue. If set to false, no additional events will be fired.
Public property	ControlRecursion	If true, the recursion control is enabled on this handler. (Inherited from AbstractHandler.)
Public property	Debug	If true, the handler is included in debug (Inherited from AbstractHandler.)
Public property	IsStatic	True, if the handler is a static handler (Inherited from AbstractHandler.)
Public property	Name	Event name. The name serves for debug purposes and to uniquely identify the handler. (Inherited from AbstractHandler.)
Public property	OneTime	If true, this event can be executed only once. If the event was already executed, and new handler is added, it executes immediately. (Inherited from AbstractHandler.)
Protected property	SupportsCancel	If true, the handler supports cancelling of the event. If set and handler is already cancelled, throws an exception.
Public property	WasExecuted	Returns true if the event was already executed (Inherited from AbstractHandler.)

Methods

	Name	Description
Protected method	AddEvent<THandler>	Adds the event to the list (Inherited from AbstractHandler.)
Protected method	AssignCurrentHandler	Assigns the current handler to the event arguments (Inherited from AbstractHandler.)
Protected method	CheckBase	Checks if the handler is base handler instance, and fires an exception if not (Inherited from AbstractHandler.)
Protected method	CheckEvent	Checks if the handler is event handler instance, and fires an exception if not (Inherited from AbstractHandler.)
Public method	Clear	Clears all bound event handlers from the event and resets the number of executions of the event (Inherited from AbstractHandler.)
Protected method	CountExecution	Counts the execution of the event (Inherited from AbstractHandler.)
Public method	Dispose	Disposes the object (Inherited from AbstractHandler.)
Protected method	Finish	Finishes the event and raises the After event actions
Protected method	Raise<TArgs>	Raises the list of events (Inherited from AbstractHandler.)
Protected method	RemoveEvent<THandler>	Removes the event from the list (Inherited from AbstractHandler.)
Public method	Reset	Resets the number of executions of the event (Inherited from AbstractHandler.)
Public method	SetParent	Sets the parent event of the event (Inherited from AbstractHandler.)

Extension Methods

	Name	Description
Public Extension Method	CanContinue	Checks whether the context of execution should continue. (Defined by HandlersExtensions.)
Public Extension Method	DontSupportCancel	Disables the ability to cancel continuation of the execution context. (Defined by HandlersExtensions.)
Public Extension Method	FinishEvent	Finishes the event and raises the After event actions. (Defined by HandlersExtensions.)