View Source

Class PublishEventArgs<TEntity>

Inheritance
System.Object
CancellableEventArgs
CancellableObjectEventArgs
CancellableObjectEventArgs<IEnumerable<TEntity>>
CancellableEnumerableObjectEventArgs<TEntity>
Namespace: Umbraco.Cms.Core.Events
Assembly: Umbraco.Core.dll
Syntax
public class PublishEventArgs<TEntity> : CancellableEnumerableObjectEventArgs<TEntity>
Type Parameters
Name Description
TEntity

Constructors

View Source

PublishEventArgs(TEntity)

Constructor accepting a single entity instance

Declaration
public PublishEventArgs(TEntity eventObject)
Parameters
Type Name Description
TEntity eventObject
View Source

PublishEventArgs(TEntity, Boolean, Boolean)

Constructor accepting a single entity instance

Declaration
public PublishEventArgs(TEntity eventObject, bool canCancel, bool isAllPublished)
Parameters
Type Name Description
TEntity eventObject
System.Boolean canCancel
System.Boolean isAllPublished
View Source

PublishEventArgs(TEntity, Boolean, EventMessages)

Constructor accepting a single entity instance

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

PublishEventArgs(TEntity, EventMessages)

Constructor accepting a single entity instance

Declaration
public PublishEventArgs(TEntity eventObject, EventMessages eventMessages)
Parameters
Type Name Description
TEntity eventObject
EventMessages eventMessages
View Source

PublishEventArgs(IEnumerable<TEntity>)

Constructor accepting multiple entities that are used in the publish operation

Declaration
public PublishEventArgs(IEnumerable<TEntity> eventObject)
Parameters
Type Name Description
IEnumerable<TEntity> eventObject
View Source

PublishEventArgs(IEnumerable<TEntity>, Boolean, Boolean)

Constructor accepting multiple entities that are used in the publish operation

Declaration
public PublishEventArgs(IEnumerable<TEntity> eventObject, bool canCancel, bool isAllPublished)
Parameters
Type Name Description
IEnumerable<TEntity> eventObject
System.Boolean canCancel
System.Boolean isAllPublished
View Source

PublishEventArgs(IEnumerable<TEntity>, Boolean, EventMessages)

Constructor accepting multiple entities that are used in the publish operation

Declaration
public PublishEventArgs(IEnumerable<TEntity> eventObject, bool canCancel, EventMessages eventMessages)
Parameters
Type Name Description
IEnumerable<TEntity> eventObject
System.Boolean canCancel
EventMessages eventMessages
View Source

PublishEventArgs(IEnumerable<TEntity>, EventMessages)

Constructor accepting multiple entities that are used in the publish operation

Declaration
public PublishEventArgs(IEnumerable<TEntity> eventObject, EventMessages eventMessages)
Parameters
Type Name Description
IEnumerable<TEntity> eventObject
EventMessages eventMessages

Properties

View Source

PublishedEntities

Returns all entities that were published during the operation

Declaration
public IEnumerable<TEntity>? PublishedEntities { get; }
Property Value
Type Description
System.Nullable<IEnumerable<TEntity>>

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(PublishEventArgs<TEntity>)

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

GetHashCode()

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

Operators

View Source

Equality(PublishEventArgs<TEntity>, PublishEventArgs<TEntity>)

Declaration
public static bool operator ==(PublishEventArgs<TEntity> left, PublishEventArgs<TEntity> right)
Parameters
Type Name Description
PublishEventArgs<TEntity> left
PublishEventArgs<TEntity> right
Returns
Type Description
System.Boolean
View Source

Inequality(PublishEventArgs<TEntity>, PublishEventArgs<TEntity>)

Declaration
public static bool operator !=(PublishEventArgs<TEntity> left, PublishEventArgs<TEntity> right)
Parameters
Type Name Description
PublishEventArgs<TEntity> left
PublishEventArgs<TEntity> right
Returns
Type Description
System.Boolean