View Source

Class QueuingEventDispatcherBase

An IEventDispatcher that queues events.

Inheritance
System.Object
Namespace: Umbraco.Core.Events
Assembly: Umbraco.Core.dll
Syntax
public abstract class QueuingEventDispatcherBase : IEventDispatcher
Remarks

Can raise, or ignore, cancelable events, depending on option.

Implementations must override ScopeExitCompleted to define what to do with the events when the scope exits and has been completed.

If the scope exits without being completed, events are ignored.

Constructors

View Source

QueuingEventDispatcherBase(Boolean)

Declaration
protected QueuingEventDispatcherBase(bool raiseCancelable)
Parameters
Type Name Description
System.Boolean raiseCancelable

Methods

View Source

Dispatch(EventHandler, Object, EventArgs, String)

Declaration
public void Dispatch(EventHandler eventHandler, object sender, EventArgs args, string eventName = null)
Parameters
Type Name Description
System.EventHandler eventHandler
System.Object sender
System.EventArgs args
System.String eventName
View Source

Dispatch<TArgs>(EventHandler<TArgs>, Object, TArgs, String)

Declaration
public void Dispatch<TArgs>(EventHandler<TArgs> eventHandler, object sender, TArgs args, string eventName = null)
Parameters
Type Name Description
System.EventHandler<TArgs> eventHandler
System.Object sender
TArgs args
System.String eventName
Type Parameters
Name Description
TArgs
View Source

Dispatch<TSender, TArgs>(TypedEventHandler<TSender, TArgs>, TSender, TArgs, String)

Declaration
public void Dispatch<TSender, TArgs>(TypedEventHandler<TSender, TArgs> eventHandler, TSender sender, TArgs args, string eventName = null)
Parameters
Type Name Description
TypedEventHandler<TSender, TArgs> eventHandler
TSender sender
TArgs args
System.String eventName
Type Parameters
Name Description
TSender
TArgs
View Source

DispatchCancelable(EventHandler, Object, CancellableEventArgs, String)

Declaration
public bool DispatchCancelable(EventHandler eventHandler, object sender, CancellableEventArgs args, string eventName = null)
Parameters
Type Name Description
System.EventHandler eventHandler
System.Object sender
CancellableEventArgs args
System.String eventName
Returns
Type Description
System.Boolean
View Source

DispatchCancelable<TArgs>(EventHandler<TArgs>, Object, TArgs, String)

Declaration
public bool DispatchCancelable<TArgs>(EventHandler<TArgs> eventHandler, object sender, TArgs args, string eventName = null)
    where TArgs : CancellableEventArgs
Parameters
Type Name Description
System.EventHandler<TArgs> eventHandler
System.Object sender
TArgs args
System.String eventName
Returns
Type Description
System.Boolean
Type Parameters
Name Description
TArgs
View Source

DispatchCancelable<TSender, TArgs>(TypedEventHandler<TSender, TArgs>, TSender, TArgs, String)

Declaration
public bool DispatchCancelable<TSender, TArgs>(TypedEventHandler<TSender, TArgs> eventHandler, TSender sender, TArgs args, string eventName = null)
    where TArgs : CancellableEventArgs
Parameters
Type Name Description
TypedEventHandler<TSender, TArgs> eventHandler
TSender sender
TArgs args
System.String eventName
Returns
Type Description
System.Boolean
Type Parameters
Name Description
TSender
TArgs
View Source

GetEvents(EventDefinitionFilter)

Declaration
public IEnumerable<IEventDefinition> GetEvents(EventDefinitionFilter filter)
Parameters
Type Name Description
EventDefinitionFilter filter
Returns
Type Description
System.Collections.Generic.IEnumerable<IEventDefinition>
View Source

ScopeExit(Boolean)

Declaration
public void ScopeExit(bool completed)
Parameters
Type Name Description
System.Boolean completed
View Source

ScopeExitCompleted()

Declaration
protected abstract void ScopeExitCompleted()