View Source

Class CancellableEnumerableObjectEventArgs<TEventObject>

Represents event data, for events that support cancellation, and expose impacted objects.

Inheritance

object

EventArgs

CancellableEventArgs

CancellableObjectEventArgs

CancellableObjectEventArgs<IEnumerable<TEventObject>>

Namespace: Umbraco.Cms.Core.Events

Assembly: Umbraco.Core.dll

Syntax

public class CancellableEnumerableObjectEventArgs<TEventObject> : CancellableObjectEventArgs<IEnumerable<TEventObject>>

Type Parameters

Name	Description
TEventObject	The type of the exposed, impacted objects.

Constructors

CancellableEnumerableObjectEventArgs(IEnumerable<TEventObject>)

Initializes a new instance of the CancellableEnumerableObjectEventArgs<TEventObject> class with cancellation enabled.

Declaration

public CancellableEnumerableObjectEventArgs(IEnumerable<TEventObject> eventObject)

Parameters

Type	Name	Description
IEnumerable<TEventObject>	eventObject	The collection of impacted objects.

CancellableEnumerableObjectEventArgs(IEnumerable<TEventObject>, bool)

Initializes a new instance of the CancellableEnumerableObjectEventArgs<TEventObject> class.

Declaration

public CancellableEnumerableObjectEventArgs(IEnumerable<TEventObject> eventObject, bool canCancel)

Parameters

Type	Name	Description
IEnumerable<TEventObject>	eventObject	The collection of impacted objects.
bool	canCancel	A value indicating whether the event can be cancelled.

CancellableEnumerableObjectEventArgs(IEnumerable<TEventObject>, bool, EventMessages)

Initializes a new instance of the CancellableEnumerableObjectEventArgs<TEventObject> class.

Declaration

public CancellableEnumerableObjectEventArgs(IEnumerable<TEventObject> eventObject, bool canCancel, EventMessages eventMessages)

Parameters

Type	Name	Description
IEnumerable<TEventObject>	eventObject	The collection of impacted objects.
bool	canCancel	A value indicating whether the event can be cancelled.
EventMessages	eventMessages	The event messages.

CancellableEnumerableObjectEventArgs(IEnumerable<TEventObject>, bool, EventMessages, IDictionary<string, object>)

Initializes a new instance of the CancellableEnumerableObjectEventArgs<TEventObject> class.

Declaration

public CancellableEnumerableObjectEventArgs(IEnumerable<TEventObject> eventObject, bool canCancel, EventMessages messages, IDictionary<string, object> additionalData)

Parameters

Type	Name	Description
IEnumerable<TEventObject>	eventObject	The collection of impacted objects.
bool	canCancel	A value indicating whether the event can be cancelled.
EventMessages	messages	The event messages.
IDictionary<string, object>	additionalData	Additional data associated with the event.

CancellableEnumerableObjectEventArgs(IEnumerable<TEventObject>, EventMessages)

Initializes a new instance of the CancellableEnumerableObjectEventArgs<TEventObject> class with cancellation enabled.

Declaration

public CancellableEnumerableObjectEventArgs(IEnumerable<TEventObject> eventObject, EventMessages eventMessages)

Parameters

Type	Name	Description
IEnumerable<TEventObject>	eventObject	The collection of impacted objects.
EventMessages	eventMessages	The event messages.

Methods

Equals(object?)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Equals(CancellableEnumerableObjectEventArgs<TEventObject>?)

Declaration

public bool Equals(CancellableEnumerableObjectEventArgs<TEventObject>? other)

Parameters

Type	Name	Description
CancellableEnumerableObjectEventArgs<TEventObject>	other

Returns

Type	Description
bool

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int