View Source

Class PublishEventArgs<TEntity>

Inheritance

object

EventArgs

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(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>, bool, bool)

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
bool	canCancel
bool	isAllPublished

View Source

PublishEventArgs(IEnumerable<TEntity>, bool, 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
bool	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

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, bool, bool)

Constructor accepting a single entity instance

Declaration

public PublishEventArgs(TEntity eventObject, bool canCancel, bool isAllPublished)

Parameters

Type	Name	Description
TEntity	eventObject
bool	canCancel
bool	isAllPublished

View Source

PublishEventArgs(TEntity, bool, EventMessages)

Constructor accepting a single entity instance

Declaration

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

Parameters

Type	Name	Description
TEntity	eventObject
bool	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

Properties

View Source

PublishedEntities

Returns all entities that were published during the operation

Declaration

public IEnumerable<TEntity>? PublishedEntities { get; }

Property Value

Type	Description
IEnumerable<TEntity>

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

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

Declaration

public bool Equals(PublishEventArgs<TEntity>? other)

Parameters

Type	Name	Description
PublishEventArgs<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 ==(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
bool

View Source

operator !=(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
bool