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?)

Declaration
public CancellableObjectEventArgs(TEventObject? eventObject)
Parameters
Type Name Description
TEventObject eventObject
View Source

CancellableObjectEventArgs(TEventObject?, bool)

Declaration
public CancellableObjectEventArgs(TEventObject? eventObject, bool canCancel)
Parameters
Type Name Description
TEventObject eventObject
bool canCancel
View Source

CancellableObjectEventArgs(TEventObject?, bool, EventMessages)

Declaration
public CancellableObjectEventArgs(TEventObject? eventObject, bool canCancel, EventMessages eventMessages)
Parameters
Type Name Description
TEventObject eventObject
bool canCancel
EventMessages eventMessages
View Source

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

Declaration
public CancellableObjectEventArgs(TEventObject? eventObject, bool canCancel, EventMessages messages, IDictionary<string, object> additionalData)
Parameters
Type Name Description
TEventObject eventObject
bool canCancel
EventMessages messages
IDictionary<string, object> additionalData
View Source

CancellableObjectEventArgs(TEventObject?, EventMessages)

Declaration
public CancellableObjectEventArgs(TEventObject? eventObject, EventMessages eventMessages)
Parameters
Type Name Description
TEventObject eventObject
EventMessages eventMessages

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?)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object? obj)
Parameters
Type Name Description
object obj

The object to compare with the current object.
Returns
Type Description
bool

true if the specified object is equal to the current object; otherwise, false.
View Source

Equals(CancellableObjectEventArgs<TEventObject>?)

Indicates whether the current object is equal to another object of the same type.

Declaration
public bool Equals(CancellableObjectEventArgs<TEventObject>? other)
Parameters
Type Name Description
CancellableObjectEventArgs<TEventObject> other

An object to compare with this object.
Returns
Type Description
bool

true if the current object is equal to the other parameter; otherwise, false.
View Source

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.

Operators

View Source

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

Declaration
public static bool operator ==(CancellableObjectEventArgs<TEventObject> left, CancellableObjectEventArgs<TEventObject> right)
Parameters
Type Name Description
CancellableObjectEventArgs<TEventObject> left
CancellableObjectEventArgs<TEventObject> right
Returns
Type Description
bool
View Source

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

Declaration
public static bool operator !=(CancellableObjectEventArgs<TEventObject> left, CancellableObjectEventArgs<TEventObject> right)
Parameters
Type Name Description
CancellableObjectEventArgs<TEventObject> left
CancellableObjectEventArgs<TEventObject> right
Returns
Type Description
bool