View Source

Class DeleteEventArgs<TEntity>

Inheritance

object

EventArgs

CancellableEventArgs

CancellableObjectEventArgs

CancellableObjectEventArgs<IEnumerable<TEntity>>

CancellableEnumerableObjectEventArgs<TEntity>

Namespace: Umbraco.Cms.Core.Events

Assembly: Umbraco.Core.dll

Syntax

[SupersedeEvent(typeof(SaveEventArgs<>))]
[SupersedeEvent(typeof(PublishEventArgs<>))]
[SupersedeEvent(typeof(MoveEventArgs<>))]
[SupersedeEvent(typeof(CopyEventArgs<>))]
public class DeleteEventArgs<TEntity> : CancellableEnumerableObjectEventArgs<TEntity>, IDeletingMediaFilesEventArgs

Type Parameters

Name	Description
TEntity

Constructors

View Source

DeleteEventArgs(IEnumerable<TEntity>)

Constructor accepting multiple entities that are used in the delete operation

Declaration

public DeleteEventArgs(IEnumerable<TEntity> eventObject)

Parameters

Type	Name	Description
IEnumerable<TEntity>	eventObject

View Source

DeleteEventArgs(IEnumerable<TEntity>, bool)

Constructor accepting multiple entities that are used in the delete operation

Declaration

public DeleteEventArgs(IEnumerable<TEntity> eventObject, bool canCancel)

Parameters

Type	Name	Description
IEnumerable<TEntity>	eventObject
bool	canCancel

View Source

DeleteEventArgs(IEnumerable<TEntity>, bool, EventMessages)

Constructor accepting multiple entities that are used in the delete operation

Declaration

public DeleteEventArgs(IEnumerable<TEntity> eventObject, bool canCancel, EventMessages eventMessages)

Parameters

Type	Name	Description
IEnumerable<TEntity>	eventObject
bool	canCancel
EventMessages	eventMessages

View Source

DeleteEventArgs(IEnumerable<TEntity>, EventMessages)

Constructor accepting multiple entities that are used in the delete operation

Declaration

public DeleteEventArgs(IEnumerable<TEntity> eventObject, EventMessages eventMessages)

Parameters

Type	Name	Description
IEnumerable<TEntity>	eventObject
EventMessages	eventMessages

View Source

DeleteEventArgs(TEntity)

Constructor accepting a single entity instance

Declaration

public DeleteEventArgs(TEntity eventObject)

Parameters

Type	Name	Description
TEntity	eventObject

View Source

DeleteEventArgs(TEntity, bool)

Constructor accepting a single entity instance

Declaration

public DeleteEventArgs(TEntity eventObject, bool canCancel)

Parameters

Type	Name	Description
TEntity	eventObject
bool	canCancel

View Source

DeleteEventArgs(TEntity, bool, EventMessages)

Constructor accepting a single entity instance

Declaration

public DeleteEventArgs(TEntity eventObject, bool canCancel, EventMessages eventMessages)

Parameters

Type	Name	Description
TEntity	eventObject
bool	canCancel
EventMessages	eventMessages

View Source

DeleteEventArgs(TEntity, EventMessages)

Constructor accepting a single entity instance

Declaration

public DeleteEventArgs(TEntity eventObject, EventMessages eventMessages)

Parameters

Type	Name	Description
TEntity	eventObject
EventMessages	eventMessages

Properties

View Source

DeletedEntities

Returns all entities that were deleted during the operation

Declaration

public IEnumerable<TEntity> DeletedEntities { get; set; }

Property Value

Type	Description
IEnumerable<TEntity>

View Source

MediaFilesToDelete

A list of media files that can be added to during a deleted operation for which Umbraco will ensure are removed

Declaration

public List<string> MediaFilesToDelete { get; }

Property Value

Type	Description
List<string>

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(DeleteEventArgs<TEntity>?)

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

Declaration

public bool Equals(DeleteEventArgs<TEntity>? other)

Parameters

Type	Name	Description
DeleteEventArgs<TEntity>	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 ==(DeleteEventArgs<TEntity>, DeleteEventArgs<TEntity>)

Declaration

public static bool operator ==(DeleteEventArgs<TEntity> left, DeleteEventArgs<TEntity> right)

Parameters

Type	Name	Description
DeleteEventArgs<TEntity>	left
DeleteEventArgs<TEntity>	right

Returns

Type	Description
bool

View Source

operator !=(DeleteEventArgs<TEntity>, DeleteEventArgs<TEntity>)

Declaration

public static bool operator !=(DeleteEventArgs<TEntity> left, DeleteEventArgs<TEntity> right)

Parameters

Type	Name	Description
DeleteEventArgs<TEntity>	left
DeleteEventArgs<TEntity>	right

Returns

Type	Description
bool