View Source

Class PublishedElementWrapped<TElement>

Provides an abstract base class for IPublishedElement implementations that wrap and extend another IPublishedElement.

Inheritance

object

Namespace: Umbraco.Cms.Core.Models.PublishedContent

Assembly: Umbraco.Core.dll

Syntax

public abstract class PublishedElementWrapped<TElement> : IPublishedElement where TElement : IPublishedElement

Type Parameters

Name	Description
TElement	The type of element to wrap.

Constructors

PublishedElementWrapped(TElement)

Initializes a new PublishedElementWrapped instance.

Declaration

protected PublishedElementWrapped(TElement content)

Parameters

Type	Name	Description
TElement	content	The content to wrap.

Properties

ContentType

Gets the content type.

Declaration

public IPublishedContentType ContentType { get; }

Property Value

Type	Description
IPublishedContentType

CreateDate

Gets the date the content item was created.

Declaration

public virtual DateTime CreateDate { get; }

Property Value

Type	Description
DateTime

CreatorId

Gets the identifier of the user who created the content item.

Declaration

public virtual int CreatorId { get; }

Property Value

Type	Description
int

Cultures

Gets available culture infos.

Declaration

public IReadOnlyDictionary<string, PublishedCultureInfo> Cultures { get; }

Property Value

Type	Description
IReadOnlyDictionary<string, PublishedCultureInfo>

Remarks

Contains only those culture that are available. For a published content, these are the cultures that are published. For a draft content, those that are 'available' ie have a non-empty content name.

Does not contain the invariant culture.

// TODO?

Id

Gets the unique identifier of the content item.

Declaration

public virtual int Id { get; }

Property Value

Type	Description
int

ItemType

Gets the type of the content item (document, media...).

Declaration

public virtual PublishedItemType ItemType { get; }

Property Value

Type	Description
PublishedItemType

Key

Gets the unique key of the published element.

Declaration

public Guid Key { get; }

Property Value

Type	Description
Guid

Name

Gets the name of the content item for the current culture.

Declaration

public virtual string Name { get; }

Property Value

Type	Description
string

Properties

Gets the properties of the element.

Declaration

public virtual IEnumerable<IPublishedProperty> Properties { get; }

Property Value

Type	Description
IEnumerable<IPublishedProperty>

Remarks

Contains one IPublishedProperty for each property defined for the content type, including inherited properties. Some properties may have no value.

SortOrder

Gets the sort order of the content item.

Declaration

public virtual int SortOrder { get; }

Property Value

Type	Description
int

UpdateDate

Gets the date the content item was last updated.

Declaration

public virtual DateTime UpdateDate { get; }

Property Value

Type	Description
DateTime

Remarks

For published content items, this is also the date the item was published.

This date is always global to the content item, see CultureDate() for the date each culture was published.

WriterId

Gets the identifier of the user who last updated the content item.

Declaration

public virtual int WriterId { get; }

Property Value

Type	Description
int

Methods

GetProperty(string)

Gets a property identified by its alias.

Declaration

public virtual IPublishedProperty? GetProperty(string alias)

Parameters

Type	Name	Description
string	alias	The property alias.

Returns

Type	Description
IPublishedProperty	The property identified by the alias.

Remarks

If the content type has no property with that alias, including inherited properties, returns null,

otherwise return a property -- that may have no value (ie HasValue is false).

The alias is case-insensitive.

IsDraft(string?)

Gets a value indicating whether the content is draft.

Declaration

public virtual bool IsDraft(string? culture = null)

Parameters

Type	Name	Description
string	culture

Returns

Type	Description
bool

Remarks

A content is draft when it is the unpublished version of a content, which may have a published version, or not.

When retrieving documents from cache in non-preview mode, IsDraft is always false, as only published documents are returned. When retrieving in preview mode, IsDraft can either be true (document is not published, or has been edited, and what is returned is the edited version) or false (document is published, and has not been edited, and what is returned is the published version).

IsPublished(string?)

Gets a value indicating whether the content is published.

Declaration

public virtual bool IsPublished(string? culture = null)

Parameters

Type	Name	Description
string	culture

Returns

Type	Description
bool

Remarks

A content is published when it has a published version.

When retrieving documents from cache in non-preview mode, IsPublished is always true, as only published documents are returned. When retrieving in draft mode, IsPublished can either be true (document has a published version) or false (document has no published version).

It is therefore possible for both IsDraft and IsPublished to be true at the same time, meaning that the content is the draft version, and a published version exists.

Unwrap()

Gets the wrapped content.

Declaration

public TElement Unwrap()

Returns

Type	Description
TElement	The wrapped content, that was passed as an argument to the constructor.