Class DeleteEventArgs<TEntity>
Represents event data for delete operations.
Inheritance
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>, IDeletingMediaFilesEventArgsType Parameters
| Name | Description |
|---|---|
| TEntity | The type of the entity being deleted. |
Constructors
View SourceDeleteEventArgs(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 |
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 |
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 |
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 |
DeleteEventArgs(TEntity)
Constructor accepting a single entity instance
Declaration
public DeleteEventArgs(TEntity eventObject)Parameters
| Type | Name | Description |
|---|---|---|
| TEntity | eventObject |
DeleteEventArgs(TEntity, bool)
Constructor accepting a single entity instance
Declaration
public DeleteEventArgs(TEntity eventObject, bool canCancel)Parameters
| Type | Name | Description |
|---|---|---|
| TEntity | eventObject | |
| bool | canCancel |
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 |
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 SourceDeletedEntities
Returns all entities that were deleted during the operation
Declaration
public IEnumerable<TEntity> DeletedEntities { get; set; }Property Value
| Type | Description |
|---|---|
| IEnumerable<TEntity> |
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 SourceEquals(object?)
Declaration
public override bool Equals(object? obj)Parameters
| Type | Name | Description |
|---|---|---|
| object | obj |
Returns
| Type | Description |
|---|---|
| bool |
Equals(DeleteEventArgs<TEntity>?)
Declaration
public bool Equals(DeleteEventArgs<TEntity>? other)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteEventArgs<TEntity> | other |
Returns
| Type | Description |
|---|---|
| bool |
GetHashCode()
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| int |
Operators
View Sourceoperator ==(DeleteEventArgs<TEntity>, DeleteEventArgs<TEntity>)
Determines whether two DeleteEventArgs<TEntity> instances are equal.
Declaration
public static bool operator ==(DeleteEventArgs<TEntity> left, DeleteEventArgs<TEntity> right)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteEventArgs<TEntity> | left | The first instance to compare. |
| DeleteEventArgs<TEntity> | right | The second instance to compare. |
Returns
| Type | Description |
|---|---|
| bool |
|
operator !=(DeleteEventArgs<TEntity>, DeleteEventArgs<TEntity>)
Determines whether two DeleteEventArgs<TEntity> instances are not equal.
Declaration
public static bool operator !=(DeleteEventArgs<TEntity> left, DeleteEventArgs<TEntity> right)Parameters
| Type | Name | Description |
|---|---|---|
| DeleteEventArgs<TEntity> | left | The first instance to compare. |
| DeleteEventArgs<TEntity> | right | The second instance to compare. |
Returns
| Type | Description |
|---|---|
| bool |
|