View Source

Class CancellableObjectEventArgs<TEventObject>

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

Inheritance
System.Object
System.EventArgs
CancellableEventArgs
CancellableObjectEventArgs
Namespace: Umbraco.Core.Events
Assembly: Umbraco.Core.dll
Syntax
public class CancellableObjectEventArgs<TEventObject> : CancellableObjectEventArgs, IEquatable<CancellableEventArgs>, IEquatable<CancellableObjectEventArgs<TEventObject>>
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, Boolean)

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

CancellableObjectEventArgs(TEventObject, Boolean, EventMessages)

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

CancellableObjectEventArgs(TEventObject, Boolean, EventMessages, IDictionary<String, Object>)

Declaration
public CancellableObjectEventArgs(TEventObject eventObject, bool canCancel, EventMessages messages, IDictionary<string, object> additionalData)
Parameters
Type Name Description
TEventObject eventObject
System.Boolean canCancel
EventMessages messages
System.Collections.Generic.IDictionary<System.String, System.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)

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Boolean
View Source

Equals(CancellableObjectEventArgs<TEventObject>)

Declaration
public bool Equals(CancellableObjectEventArgs<TEventObject> other)
Parameters
Type Name Description
CancellableObjectEventArgs<TEventObject> other
Returns
Type Description
System.Boolean
View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Operators

View Source

Equality(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
System.Boolean
View Source

Inequality(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
System.Boolean