View Source

Class CancellableObjectEventArgs<TEventObject>

Represent event data, for events that support cancellation, and expose an impacted object.

Inheritance

object

EventArgs

CancellableEventArgs

CancellableObjectEventArgs

Namespace: Umbraco.Cms.Core.Events

Assembly: Umbraco.Core.dll

Syntax

public class CancellableObjectEventArgs<TEventObject> : CancellableObjectEventArgs

Type Parameters

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

Constructors

View Source

CancellableObjectEventArgs(TEventObject?)

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

Declaration

public CancellableObjectEventArgs(TEventObject? eventObject)

Parameters

Type	Name	Description
TEventObject	eventObject	The impacted object.

View Source

CancellableObjectEventArgs(TEventObject?, bool)

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

Declaration

public CancellableObjectEventArgs(TEventObject? eventObject, bool canCancel)

Parameters

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

View Source

CancellableObjectEventArgs(TEventObject?, bool, EventMessages)

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

Declaration

public CancellableObjectEventArgs(TEventObject? eventObject, bool canCancel, EventMessages eventMessages)

Parameters

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

View Source

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

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

Declaration

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

Parameters

Type	Name	Description
TEventObject	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.

View Source

CancellableObjectEventArgs(TEventObject?, EventMessages)

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

Declaration

public CancellableObjectEventArgs(TEventObject? eventObject, EventMessages eventMessages)

Parameters

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

Properties

View Source

EventObject

Gets or sets the impacted object.

Declaration

protected TEventObject? EventObject { get; set; }

Property Value

Type	Description
TEventObject

Remarks

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

Methods

View Source

Equals(object?)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

View Source

Equals(CancellableObjectEventArgs<TEventObject>?)

Declaration

public bool Equals(CancellableObjectEventArgs<TEventObject>? other)

Parameters

Type	Name	Description
CancellableObjectEventArgs<TEventObject>	other

Returns

Type	Description
bool

View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Operators

View Source

operator ==(CancellableObjectEventArgs<TEventObject>, CancellableObjectEventArgs<TEventObject>)

Determines whether two CancellableObjectEventArgs<TEventObject> instances are equal.

Declaration

public static bool operator ==(CancellableObjectEventArgs<TEventObject> left, CancellableObjectEventArgs<TEventObject> right)

Parameters

Type	Name	Description
CancellableObjectEventArgs<TEventObject>	left	The first instance to compare.
CancellableObjectEventArgs<TEventObject>	right	The second instance to compare.

Returns

Type	Description
bool	`true` if the instances are equal; otherwise, `false`.

View Source

operator !=(CancellableObjectEventArgs<TEventObject>, CancellableObjectEventArgs<TEventObject>)

Determines whether two CancellableObjectEventArgs<TEventObject> instances are not equal.

Declaration

public static bool operator !=(CancellableObjectEventArgs<TEventObject> left, CancellableObjectEventArgs<TEventObject> right)

Parameters

Type	Name	Description
CancellableObjectEventArgs<TEventObject>	left	The first instance to compare.
CancellableObjectEventArgs<TEventObject>	right	The second instance to compare.

Returns

Type	Description
bool	`true` if the instances are not equal; otherwise, `false`.