View Source

Interface IContentBase

Provides a base class for content items.

Namespace: Umbraco.Cms.Core.Models

Assembly: Umbraco.Core.dll

Syntax

public interface IContentBase : IUmbracoEntity, ITreeEntity, IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty

Remarks

Content items are documents, medias and members.

Content items have a content type, and properties.

Properties

AvailableCultures

Gets the available cultures.

Declaration

IEnumerable<string> AvailableCultures { get; }

Property Value

Type	Description
IEnumerable<System.String>

Remarks

Cannot contain the invariant culture, which is always available.

ContentType

Gets the content type of this content.

Declaration

ISimpleContentType ContentType { get; }

Property Value

Type	Description
ISimpleContentType

ContentTypeId

Integer Id of the default ContentType

Declaration

int ContentTypeId { get; }

Property Value

Type	Description
System.Int32

CultureInfos

Gets culture infos of the content item.

Declaration

ContentCultureInfosCollection CultureInfos { get; set; }

Property Value

Type	Description
ContentCultureInfosCollection

Remarks

Because a dictionary key cannot be null this cannot contain the invariant culture name, which must be get or set via the Name property.

Properties

List of properties, which make up all the data available for this Content object

Declaration

IPropertyCollection Properties { get; set; }

Property Value

Type	Description
IPropertyCollection

Remarks

Properties are loaded as part of the Content object graph

VersionId

Gets the version identifier.

Declaration

int VersionId { get; set; }

Property Value

Type	Description
System.Int32

WriterId

Gets the identifier of the writer.

Declaration

int WriterId { get; set; }

Property Value

Type	Description
System.Int32

Methods

GetCultureName(String)

Gets the name of the content item for a specified language.

Declaration

string GetCultureName(string culture)

Parameters

Type	Name	Description
System.String	culture

Returns

Type	Description
System.String

Remarks

When culture is null, gets the invariant culture name, which is the value of the Name property.

When culture is not null, and the content type does not vary by culture, returns null.

GetUpdateDate(String)

Gets the date a culture was updated.

Declaration

DateTime? GetUpdateDate(string culture)

Parameters

Type	Name	Description
System.String	culture

Returns

Type	Description
System.Nullable<DateTime>

Remarks

When culture is null, returns null.

If the specified culture is not available, returns null.

GetValue(String, String, String, Boolean)

Gets the value of a Property

Declaration

object GetValue(string propertyTypeAlias, string culture = null, string segment = null, bool published = false)

Parameters

Type	Name	Description
System.String	propertyTypeAlias
System.String	culture
System.String	segment
System.Boolean	published

Returns

Type	Description
System.Object

Remarks

Values 'null' and 'empty' are equivalent for culture and segment.

GetValue<TValue>(String, String, String, Boolean)

Gets the typed value of a Property

Declaration

TValue GetValue<TValue>(string propertyTypeAlias, string culture = null, string segment = null, bool published = false)

Parameters

Type	Name	Description
System.String	propertyTypeAlias
System.String	culture
System.String	segment
System.Boolean	published

Returns

Type	Description
TValue

Type Parameters

Name	Description
TValue

Remarks

Values 'null' and 'empty' are equivalent for culture and segment.

HasProperty(String)

Gets a value indicating whether the content entity has a property with the supplied alias.

Declaration

bool HasProperty(string propertyTypeAlias)

Parameters

Type	Name	Description
System.String	propertyTypeAlias

Returns

Type	Description
System.Boolean

Remarks

Indicates that the content entity has a property with the supplied alias, but not necessarily that the content has a value for that property. Could be missing.

IsCultureAvailable(String)

Gets a value indicating whether a given culture is available.

Declaration

bool IsCultureAvailable(string culture)

Parameters

Type	Name	Description
System.String	culture

Returns

Type	Description
System.Boolean

Remarks

A culture becomes available whenever the content name for this culture is non-null, and it becomes unavailable whenever the content name is null.

Returns false for the invariant culture, in order to be consistent with AvailableCultures, even though the invariant culture is always available.

Does not support the '*' wildcard (returns false).

SetCultureName(String, String)

Sets the name of the content item for a specified culture.

Declaration

void SetCultureName(string value, string culture)

Parameters

Type	Name	Description
System.String	value
System.String	culture

Remarks

When culture is null, sets the invariant culture name, which sets the Name property.

When culture is not null, throws if the content type does not vary by culture.

SetValue(String, Object, String, String)

Sets the (edited) value of a Property

Declaration

void SetValue(string propertyTypeAlias, object value, string culture = null, string segment = null)

Parameters

Type	Name	Description
System.String	propertyTypeAlias
System.Object	value
System.String	culture
System.String	segment

Remarks

Values 'null' and 'empty' are equivalent for culture and segment.