View Source

Class CancellableObjectEventArgs

Provides a base class for classes representing event data, for events that support cancellation, and expose an impacted object.

Inheritance

object

EventArgs

CancellableEventArgs

Namespace: Umbraco.Cms.Core.Events

Assembly: Umbraco.Core.dll

Syntax

public abstract class CancellableObjectEventArgs : CancellableEventArgs

Constructors

CancellableObjectEventArgs(object?)

Initializes a new instance of the CancellableObjectEventArgs class with cancellation enabled.

Declaration

protected CancellableObjectEventArgs(object? eventObject)

Parameters

Type	Name	Description
object	eventObject	The impacted object.

CancellableObjectEventArgs(object?, bool)

Initializes a new instance of the CancellableObjectEventArgs class.

Declaration

protected CancellableObjectEventArgs(object? eventObject, bool canCancel)

Parameters

Type	Name	Description
object	eventObject	The impacted object.
bool	canCancel	A value indicating whether the event can be cancelled.

CancellableObjectEventArgs(object?, bool, EventMessages)

Initializes a new instance of the CancellableObjectEventArgs class.

Declaration

protected CancellableObjectEventArgs(object? eventObject, bool canCancel, EventMessages eventMessages)

Parameters

Type	Name	Description
object	eventObject	The impacted object.
bool	canCancel	A value indicating whether the event can be cancelled.
EventMessages	eventMessages	The event messages.

CancellableObjectEventArgs(object?, bool, EventMessages, IDictionary<string, object>)

Initializes a new instance of the CancellableObjectEventArgs class.

Declaration

protected CancellableObjectEventArgs(object? eventObject, bool canCancel, EventMessages messages, IDictionary<string, object> additionalData)

Parameters

Type	Name	Description
object	eventObject	The impacted object.
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.

CancellableObjectEventArgs(object?, EventMessages)

Initializes a new instance of the CancellableObjectEventArgs class with cancellation enabled.

Declaration

protected CancellableObjectEventArgs(object? eventObject, EventMessages eventMessages)

Parameters

Type	Name	Description
object	eventObject	The impacted object.
EventMessages	eventMessages	The event messages.

Properties

EventObject

Gets or sets the impacted object.

Declaration

public object? EventObject { get; set; }

Property Value

Type	Description
object

Remarks

This is protected so that inheritors can expose it with their own name