A DataType is what you see in the backoffice in the Settings / DataTypes tree. The listed nodes are definitions of the DataTypes that are available to use on your PropertyTypes.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statement:

Constructors

new DataType(IDataEditor editor, IConfigurationEditorJsonSerializer serializer, int parentId = -1)

Constructor for creating a new DataType object where the necessary parameters are a IDataEditor and a IConfigurationEditorJsonSerializer. Optionally, the parentId can be added, if not provided the default value is -1, which means it will be created at root level.

Properties

.CreateDate

Gets or Sets a DateTime object, indicating then the given DataType was created.

.CreatorId

Gets or Sets the Id of the User who created the DataType.

.DatabaseType

Gets or Sets the DatabaseType as a ValueStorageType enum for which the DataType's value is saved as.

.Id

Returns the unique DataType ID as an Int. The ID, derived from a database identity field, isn't safe for code references as they are moved across instances. Therefore it's recommended to use Key instead.

.Key

Returns the Guid assigned to the DataType during creation. This value is unique, and should never change, even if the DataType is moved between instances.

.Level

Gets or Sets the given DataType level in the site hierarchy as an Int. DataType placed at the root of the site, will return 1, DataType right underneath will return 2, and so on.

.Name

Gets or Sets the name of the DataType as a String.

.ParentId

Gets or Sets the parent DataType Id as an Int.

.Path

Gets or Sets the path of the DataType as a String. This string contains a comma separated list of the ancestor Ids including the current contents own id at the end of the string.

.SortOrder

Returns the given DataType index, compared to sibling DataType.

.Trashed

Returns a Bool indicating whether the given DataType is currently in the recycle bin.

The Content class represents a single item in the content tree, its values are fetched directly from the database, not from the cache. Notice the Content class should strictly be used for CRUD operations, not complex queries, as it is not flexible nor fast enough for this.

All content is versioned, so on each individual change, a new version is stored. Past versions can only be retrieved from the Content api, not from the cache.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statements:

Constructors

new Content(string name, IContent parent, IContentType contentType, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the parent of the Content as an IContent object and the ContentType as an IContentType object for the Content being created. In addition, there is an optional parameter for the culture.

new Content(string name, IContent parent, IContentType contentType, int userId, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the parent of the Content as an IContent object, the ContentType as an IContentType object for the Content being created and the id of the user as a int. In addition, there is an optional parameter for the culture.

new Content(string name, IContent parent, IContentType contentType, PropertyCollection properties, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the parent of the Content as an IContent object, the ContentType as an IContentType object and a PropertyCollection for the Content being created. In addition, there is an optional parameter for the culture.

new Content(string name, int parentId, IContentType contentType, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the id of the parent as int and the ContentType as an IContentType object for the Content being created. In addition, there is an optional parameter for the culture.

new Content(string name, int parentId, IContentType contentType, int userId, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the parent id of the Content as an int object, the ContentType as an IContentType object for the Content being created and the id of the user as a int. In addition, there is an optional parameter for the culture.

new Content(string name, int parentId, IContentType contentType, PropertyCollection properties, string culture = null)

Constructor for creating a new Content object where the necessary parameters are the name of the Content, the id of the parent as int, the ContentType as an IContentType object and a PropertyCollection for the Content being created.In addition, there is an optional parameter for the culture.

Properties

.CreateDate

Gets or Sets a DateTime object, indicating then the given Content was created.

.CreatorId

Gets or Sets the Id of the User who created the Content.

.ContentType

Returns a ISimpleContentType object representing the DocumentType used by the given Content.

.ContentTypeId

Returns the id as an int of the ContentType object representing the DocumentType used by the given Content.

.Id

Returns the unique Content Id as a Int, this ID is based on a Database identity field, and is therefore not safe to reference in code which are moved between different instances, use Key instead.

.Key

Returns the Guid assigned to the Content during creation. This value is unique, and should never change, even if the content is moved between instances.

.PublishedCultures

Gets Languages of the Content as a IEnumerable<string>.

.Level

Gets or Sets the given Content level in the site hierarchy as an Int. Content placed at the root of the site, will return 1, content right underneath will return 2, and so on.

.Name

Gets or Sets the name of the content as a String.

.ParentId

Gets or Sets the parent Content Id as an Int.

.Path

Gets or Sets the path of the content as a String. This string contains a comma separated list of the ancestor Ids including the current contents own id at the end of the string.

.Properties

Gets or Sets the IPropertyCollection object, which is a collection of IProperty objects. Each property corresponds to a PropertyType, which is defined on the ContentType.

.Published

Returns a Bool indicating whether the given Content is published and available on the website or not. Notice: the published flag does not check the current in-memory cache, so this flag is not a guarantee that the Content is/is not available in the cache and the frontend of the website.

.PublishDate

If set, returns DateTime? indicating when the Content should be published and made available on the website and cache.

.SortOrder

Returns the given Content index, compared to sibling content.

.PublishedState

Returns a IPublishedState enum with the status of the Content being either Unpublished, Published, Publishing, Unpublishing.

.TemplateId

Gets or sets the template id used to render the content.

.Trashed

Returns a Bool indicating whether the given Content is currently in the recycle bin.

.UpdateDate

Gets or Sets a DateTime object, indicating when the given Content was last updated.

.VersionId

Returns the current Version Id as a int, for each change made to a content item, its values are stored under a new Version. This version is identified by a int.

.WriterId

Gets or Sets the Id of the User who made the latest edit on the Content.

Methods

.GetCreatorProfile(IUserService userService)

Gets the IProfile object for the Creator of this Content, which contains the Id and Name of the User who created this Content item.

.GetValue(string propertyTypeAlias)

Gets the value of a Property as an Object.

.GetValue< TPassType >(string propertyTypeAlias)

Gets the value of a Property as the defined type 'TPassType'.

.GetWriterProfile(IUserService userService)

Gets the IProfile object for the Writer of this Content, which contains the Id and Name of the User who last updated this Content item.

.HasProperty(string propertyTypeAlias)

Returns a Bool indicating whether the Content object has a property with the supplied alias.

.SetValue(string propertyTypeAlias, object value)

Sets the value of a property by its alias.

.ToXml(IEntityXmlSerializer serializer)

Returns an XElement containing the Content data, based off the latest changes. Is used when the published content is sent to the in-memory xml cache.

The Media class represents a single item in the media tree, its values are fetched directly from the database, not from the cache. Notice the Media class should strictly be used for CRUD operations. Media is already stored in cache, so for querying Media you'd want to use the IUmbracoContext.IPublishedMediaCache to get the media. Then one would use LINQ to query and filter the collection.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statements:

using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Services;

Constructors

new Media(string name, IMedia parent, IMediaType mediaType)

Constructor for creating a new Media object where the necessary parameters are the name of the Media, the parent of the Media as an IMedia object and the MediaType as an IMediaType object for the Media being created.

new Media(string name, IMedia parent, IMediaType mediaType, IPropertyCollection properties)

Constructor for creating a new Media object where the necessary parameters are the name of the Media, the parent of the Media as an IMedia object, the MediaType as an IMediaType object and a IPropertyCollection for the Media being created.

new Media(string name, int parentId, IMediaType mediaType)

Constructor for creating a new Media object where the necessary parameters are the name of the Media, the id of the parent as int and the MediaType as an IMediaType object for the Media being created.

new Media(string name, int parentId, IMediaType mediaType, IPropertyCollection properties)

Constructor for creating a new Media object where the necessary parameters are the name of the Media, the id of the parent as int, the MediaType as an IMediaType object and a IPropertyCollection for the Media being created.

Properties

.CreateDate

Gets or Sets a DateTime object, indicating then the given Media was created.

// Given a `MediaService` object get Media by its Id and return CreateDate
var media = mediaService.GetById(1234);
return media.CreateDate;

.CreatorId

Gets or Sets the Id of the User as an int who created the Media.

// Given a `MediaService` object get Media by its Id and return the Id of the Creator
var media = mediaService.GetById(1234);
return media.CreatorId;

.ContentType

Returns a ISimpleContentType object representing the ContentType used by the given Media.

// Given a `MediaService` object get Media by its Id and return MediaType
var media = mediaService.GetById(1234);
return media.ContentType;

.ContentTypeId

Returns the id as an int of the MediaType object representing the ContentType used by the given Media.

// Given a `MediaService` object get Media by its Id and return the Id of the MediaType
var media = mediaService.GetById(1234);
return media.ContentTypeId;

.Id

Returns the unique Media Id as a Int, this ID is based on a Database identity field, and is therefore not safe to reference in code which are moved between different instances, use Key instead.

.Key

Returns the Guid assigned to the Media during creation. This value is unique, and should never change, even if the Media is moved between instances.

// Given a `MediaService` object get Media by its Id and return the Key
var media = mediaService.GetById(1234);
return media.Key;

.Level

Gets or Sets the given Media level in the site hierarchy as an Int. Media placed at the root of the tree, will return 1, Media right underneath will return 2, and so on.

// Given a `MediaService` object get Media by its Id and return the Level
var media = mediaService.GetById(1234);
return media.Level;

.Name

Gets or Sets the name of the Media as a String.

// Given a `MediaService` object get Media by its Id and return its Name
var media = mediaService.GetById(1234);
return media.Name;

.ParentId

Gets or Sets the parent Media Id as an Int.

// Given a `MediaService` object get Media by its Id and return the Id of the Parent Media
var media = mediaService.GetById(1234);
return media.ParentId;

.Path

Gets or Sets the path of the Media as a String. This string contains a comma separated list of the ancestors Ids including the current medias own id at the end of the string.

// Given a `MediaService` object get Media by its Id and return the Path
var media = mediaService.GetById(1234);
return media.Path;

.Properties

Gets or Sets the PropertyCollection object, which is a collection of Property objects. Each property corresponds to a PropertyType, which is defined on the MediaType.

// Given a `MediaService` object get Media by its Id and loop through all Properties
var media = mediaService.GetById(1234);
foreach(var property in media.Properties){
    string alias = property.Alias;
    object value = property.GetValue();
}

.SortOrder

Returns the given Media index, compared to sibling media.

// Given a `MediaService` object get Media by its Id and return its SortOrder
var media = mediaService.GetById(1234);
return media.SortOrder;

.Trashed

Returns a Bool indicating whether the given Media is currently in the recycle bin.

// Given a `MediaService` object get Media by its Id and return Trashed
var media = mediaService.GetById(1234);
return media.Trashed;

.UpdateDate

Gets or Sets a DateTime object, indicating when the given Media was last updated.

// Given a `MediaService` object get Media by its Id and return UpdateDate
var media = mediaService.GetById(1234);
return media.UpdateDate;

.Version

Returns the current Version Id as a Guid, For each change made to a Media item, its values are stored under a new Version. This version is identified by a Guid.

Methods

.ChangeContentType(IMediaType mediaType)

Changes the IMediaType for the current Media object and removes PropertyTypes and Properties, which are not part of the new MediaType. Please use with caution as this remove differences between the new and old MediaType.

// Given a `ContentTypeService` object get the MediaType that we're changing to,
// get the Media from the `MediaService` for which we want to change MediaType for,
// and then save the Media through the MediaService.
var mediaType = contentTypeService.GetMediaType(1122);
var media = mediaService.GetById(1234);
media.ChangeContentType(mediaType);
mediaService.Save(media);

.GetCreatorProfile()

Gets the IProfile object for the Creator of this Media, which contains the Id and Name of the User who created this Media item.

// Given a `MediaService` object get Media by its Id and get the `IProfile` of the Creator
var media = mediaService.GetById(1234);
var profile = media.GetCreatorProfile();
var id = profile.Id;
string name = profile.Name;

.GetValue(string propertyTypeAlias)

Gets the value of a Property as an Object.

// Given a `MediaService` object get Media by its Id and get a value by alias
var media = mediaService.GetById(1234);
object value = media.GetValue("height");
int text = int.Parse(value.ToString());

.GetValue< TPassType >(string propertyTypeAlias)

Gets the value of a Property as the defined type 'TPassType'.

// Given a `MediaService` object get Media by its Id and get a value by alias while specifying the return type
var media = mediaService.GetById(1234);
int value = media.GetValue<int>("height");

.HasProperty(string propertyTypeAlias)

Returns a Bool indicating whether the Media object has a property with the supplied alias.

// Given a `MediaService` object get Media by its Id and check if certain properties exist
var media = mediaService.GetById(1234);
bool tagsExists = media.HasProperty("myTagProperty");
bool textExists = media.HasProperty("altText");

.SetValue(string propertyTypeAlias, object value)

Sets the value of a property by its alias.

// Given a `MediaService` object get Media by its Id, set a few values
// and saves the Media through the `MediaService`
var media = mediaService.GetById(1234);
media.SetValue("altText", "Alternative text for this media item");
media.SetValue("date", DateTime.Now);
mediaService.Save(media);

It is worth noting that it is also possible to pass a HttpPostedFile, HttpPostedFileBase or HttpPostedFileWrapper to the SetValue method, so it can be used for uploads.

.ToXml()

Returns an XElement containing the Media data, based off the latest changes. When the Media item is saved the xml is stored in the database.

// Given a `MediaService` object get Media by its Id and returns the xml
var media = mediaService.GetById(1234);
XElement xml = media.ToXml(serializer);
return xml;

Represents a Dictionary Item. A Dictionary Item is what you see in the Translation / Dictionary tree.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statement:

using Umbraco.Cms.Core.Models;

Constructors

new DictionaryItem(string itemKey)

Constructor for creating a new DictionaryItem object where the necessary parameter is the key of the DictionaryItem as a string.

new DictionaryItem(Guid? parentId, string itemKey)

Constructor for creating a new DictionaryItem object where the necessary parameters are the parentKey as Guid and the key of the DictionaryItem as a string. Use this one if you want to create a DictionaryItem underneath another one.

Properties

.ItemKey

Gets or sets the Key for the Dictionary Item.

// Create a DictionaryItem and return the key
var dictionaryItem = new DictionaryItem("your_key");
return dictionaryItem.ItemKey;

.ParentId

Gets or Sets a Guid? of the Dictionary Item ParentId.

// Create a DictionaryItem and return the parentId
DictionaryItem dictionaryItem = new DictionaryItem("your_key");
Guid? parentId = dictionaryItem.ParentId;
return parentId;

.Translations

Gets or sets a IEnumerable<IDictionaryTranslation> of translations for the Dictionary Item.

// Create a DictionaryItem and return the translations
var dictionaryItem = new DictionaryItem("your_key");
return dictionaryItem.Translations;

The RelationType class represents a relation definition between two node types (content or media). For example keeping track of node usage across the site, in order to avoid deleting content that is used else where. When querying a relation, it is typically done using the parent node key. However, if the RelationType is bidirectional, querying with the child node key is also possible.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statement:

using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Services;

Constructors

new RelationType(string name, string alias, bool isBidrectional, Guid? parentObjectType, Guid? childObjectType)

Create a new RelationType object with this constructor. It requires a string alias, the relation type's name, and a bool for bidirectionality. Additionally, specify the Guid? keys for both child and parent object types involved in the relation.

Properties

.Name

Gets or sets the Name of the RelationType as a String.

// Given a `RelationService` object get RelationType by its Id and return Name
var relationType = relationService.GetRelationTypeById(1234);
return relationType.Name;

.Alias

Gets or sets the Alias of the RelationType as String.

// Given a `RelationService` object get RelationType by its Id and return Alias
var relationType = relationService.GetRelationTypeById(1234);
return relationType.Alias;

.IsBidirectional

Gets or sets a boolean indicating whether the RelationType is Bidirectional (true) or Parent to Child (false)

// Given a `RelationService` object get RelationType by its Id and return IsBidirectional
var relationType = relationService.GetRelationTypeById(1234);
return relationType.IsBidirectional;

.ParentObjectType

Gets or sets the Parents object type key as Guid?

// Given a `RelationService` object get RelationType by its Id and return ParentObjectType
var relationType = relationService.GetRelationTypeById(1234);
return relationType.ParentObjectType;

.ChildObjectType

Gets or sets the Childs object type key as Guid?

// Given a `RelationService` object get RelationType by its Id and return ChildObjectType
var relationType = relationService.GetRelationTypeById(1234);
return relationType.ChildObjectType;

A ContentType corresponds to the Document Type found in the backoffice. The ContentType is a model / data definition for your content nodes. Every content node on an Umbraco web site always maps to a backing Document Type.

A Document Type is composed by Properties, which are grouped by Tabs (or PropertyGroups in the API). It can also inherit properties and tabs from other Document Types.

It is possible to link one or more Templates to a Document Type. This determines how your model/data is rendered to the user.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statements:

using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Services;

Constructors

ContentType(IShortStringHelper shortStringHelper, IContentType parent, string alias)

Constructor for creating a new ContentType object. The necessary parameters are a short string helper IShortStringHelper, the parent ContentType as an IContentType and the alias of the new ContentType as string.

new ContentType(IShortStringHelper shortStringHelper, int parentId)

Constructor for creating a new ContentType object where the necessary parameters are a short string helper IShortStringHelper and the Id of the parent ContentType as an Int.

Properties

.Alias

Gets or Sets the Alias as a String of the ContentType.

// Given a `ContentTypeService` object get ContentType by its Id and return Alias
var contentType = contentTypeService.Get(1234);
return contentType.Alias;

.AllowedAsRoot

Gets or Sets a Bool indicating whether this ContentType is allowed at the root. If one or more ContentTypes are set to 'AllowedAsRoot' only they are shown in the create dialog at the root level in the backoffice.

// Given a `ContentTypeService` object get ContentType by its Id and return AllowedAsRoot
var contentType = contentTypeService.Get(1234);
return contentType.AllowedAsRoot;

.AllowedContentTypes

Gets or Sets an Enumerable list of ContentTypeSort objects of the ContentTypes allowed under the current ContentType.

The ContentTypeSort is an object with a lazy Id, int SortOrder and string Alias used to sort the MediaTypes within the list of AllowedContentTypes.

// Given a `ContentTypeService` object get ContentType by its Id and return AllowedContentTypes
var contentType = contentTypeService.Get(1234);
return contentType.AllowedContentTypes;

.AllowedTemplates

Gets or Sets an Enumerable list of ITemplates which are allowed for the current ContentType.

// Given a `ContentTypeService` object get ContentType by its Id and return AllowedTemplates
var contentType = contentTypeService.Get(1234);
return contentType.AllowedTemplates;

.ContentTypeComposition

Gets a list of ContentTypes as IContentTypeComposition objects that make up a composition of PropertyGroups and PropertyTypes for the current ContentType.

The ContentTypeComposition provides a mixin-type functionality in that you can compose a ContentType of one or more other ContentTypes in a complex structure. But please be aware that the backoffice does not fully support these complex structures yet.

// Given a `ContentTypeService` object get ContentType by its Id and return ContentTypeComposition
var contentType = contentTypeService.Get(1234);
return contentType.ContentTypeComposition;

.CompositionPropertyGroups

Gets a list of all 'PropertyGroup` objects from the composition including PropertyGroups from the current ContentType.

// Given a `ContentTypeService` object get ContentType by its Id and return CompositionPropertyGroups
var contentType = contentTypeService.Get(1234);
return contentType.CompositionPropertyGroups;

.CompositionPropertyTypes

Gets a list of all PropertyType objects from the composition including PropertyTypes from the current ContentType.

// Given a `ContentTypeService` object get ContentType by its Id and return CompositionPropertyTypes
var contentType = contentTypeService.Get(1234);
return contentType.CompositionPropertyTypes;

.CreateDate

Gets or Sets a DateTime object, indicating then the given ContentType was created.

// Given a `ContentTypeService` object get ContentType by its Id and return CreateDate
var contentType = contentTypeService.Get(1234);
return contentType.CreateDate;

.CreatorId

Gets or Sets the Id of the User who created the ContentType.

// Given a `ContentTypeService` object get ContentType by its Id and return the Id of the Creator
var contentType = contentTypeService.Get(1234);
return contentType.CreatorId;

.Description

Gets or Sets the Description as a String for the ContentType.

// Given a `ContentTypeService` object get ContentType by its Id and return the Description
var contentType = contentTypeService.Get(1234);
return contentType.Description;

.DefaultTemplate

Gets the default Template set as an ITemplate object for this ContentType.

// Given a `ContentTypeService` object get ContentType by its Id and return the DefaultTemplate
var contentType = contentTypeService.Get(1234);
return contentType.DefaultTemplate;

.Icon

Gets or Sets the Icon as a String for the ContentType.

// Given a `ContentTypeService` object get ContentType by its Id and return the Icon
var contentType = contentTypeService.Get(1234);
return contentType.Icon;

.Id

Gets the unique ContentType Id as an Int. The ID, derived from a database identity field, isn't safe for code references as they are moved across instances. Therefore it's recommended to use Key instead.

.Key

Gets the Guid assigned to the ContentType during creation. This value is unique, and should never change, even if the content is moved between instances.

// Given a `ContentTypeService` object get ContentType by its Id and return the Key
var contentType = contentTypeService.Get(1234);
return contentType.Key;

.Level

Gets or Sets the given ContentType level in the site hierarchy as an Int. ContentTypes placed at the root of the tree, will return 1, content right underneath will return 2, and so on.

// Given a `ContentTypeService` object get ContentType by its Id and return the Level
var contentType = contentTypeService.Get(1234);
return contentType.Level;

.Name

Gets or Sets the name of the ContentType as a String.

// Given a `ContentTypeService` object get ContentType by its Id and return its Name
var contentType = contentTypeService.Get(1234);
return contentType.Name;

.ParentId

Gets or Sets the parent ContentType Id as an Int.

// Given a `ContentTypeService` object get ContentType by its Id and return the Id of the Parent ContentType
var contentType = contentTypeService.Get(1234);
return contentType.ParentId;

.Path

Gets or Sets the path of the ContentType as a String. This string contains a comma separated list of the ancestors Ids including the current ContentTypes own id at the end of the string.

// Given a `ContentTypeService` object get ContentType by its Id and return the Path
var contentType = contentTypeService.Get(1234);
return contentType.Path;

.PropertyGroups

Gets or Sets a PropertyGroupCollection containing a list of PropertyGroups for the current ContentType.

// Given a `ContentTypeService` object get ContentType by its Id and return PropertyGroups
var contentType = contentTypeService.Get(1234);
return contentType.PropertyGroups;

.PropertyTypes

Gets an Enumerable list of PropertyTypes aggregated for all groups within the current ContentType, as well as PropertyTypes not within a group.

// Given a `ContentTypeService` object get ContentType by its Id and return PropertyTypes
var contentType = contentTypeService.Get(1234);
return contentType.PropertyTypes;

.SortOrder

Gets the given ContentType index, compared to sibling content.

// Given a `ContentTypeService` object get ContentType by its Id and return its SortOrder
var contentType = contentTypeService.Get(1234);
return contentType.SortOrder;

.Thumbnail

Gets or Sets the Thumbnail as a String for the ContentType.

// Given a `ContentTypeService` object get ContentType by its Id and return the Thumbnail
var contentType = contentTypeService.Get(1234);
return contentType.Thumbnail;

Methods

.AddContentType(IContentTypeComposition contentType)

Adds a new ContentType to the list of composite ContentTypes.

// Given a `ContentTypeService` object get a few ContentTypes by their alias
// and add the 'Meta' and 'SEO' ContentTypes to the composition of the 'Textpage' ContentType.
var metaContentType = contentTypeService.Get("meta");
var seoContentType = contentTypeService.Get("seo");
var textpageContentType = contentTypeService.Get("textPage");
textpageContentType.AddContentType(metaContentType);
textpageContentType.AddContentType(seoContentType);
contentTypeService.Save(textpageContentType);

.CompositionAliases()

Returns an Enumerable list of ContentType aliases as String from the current composition.

// Given a `ContentTypeService` object get a ContentType by its alias and loop through CompositionAliases
var contentType = contentTypeService.Get("textPage");
var aliases = contentType.CompositionAliases();

.CompositionIds()

Returns an Enumerable list of ContentType Ids as Int from the current composition.

// Given a `ContentTypeService` object get a ContentType by its alias and loop through CompositionIds
var contentType = contentTypeService.Get("textPage");
var ids = contentType.CompositionIds();

.ContentTypeCompositionExists(string alias)

Checks if a ContentType with the supplied alias exists in the list of composite ContentTypes.

// Given a `ContentTypeService` object get a ContentType by its alias
// and check if a given ContentType exists in the composition of the 'Text Page' ContentType.
var contentType = contentTypeService.Get("textPage");
bool result = contentType.ContentTypeCompositionExists("meta");

.SetDefaultTemplate(ITemplate template)

Sets the default Template for the current ContentType.

// Given a `ContentTypeService` object get a ContentType by its alias
// and change the default template with another one from the list of allowed templates.
var contentType = contentTypeService.Get("textPage");
ITemplate template = contentType.AllowedTemplates.First(x => x.Alias == "anotherTemplate");
contentType.SetDefaultTemplate(template);
contentTypeService.Save(contentType);

.RemoveContentType(string alias)

Removes a ContentType with the supplied alias from the list of composite ContentTypes.

// Given a `ContentTypeService` object get a ContentType by its alias and
// remove the 'Meta' ContentType from its composition.
var contentType = contentTypeService.Get("textPage");
bool success = contentType.RemoveContentType("meta");
if(success)
    contentTypeService.Save(contentType);

.RemovePropertyType(string propertyTypeAlias)

Removes a PropertyType from the current ContentType.

// Given a `ContentTypeService` object get a ContentType by its alias
// and remove a PropertyType from the list of PropertyTypes.
var contentType = contentTypeService.Get("textPage");
contentType.RemovePropertyType("author");
contentTypeService.Save(contentType);

.RemoveTemplate(ITemplate template)

Removes a Template from the list of allowed templates.

// Given a `ContentTypeService` object get a ContentType by its alias
// and remove one of the templates from the list of allowed templates.
var contentType = contentTypeService.Get("textPage");
ITemplate template = contentType.AllowedTemplates.First(x => x.Alias == "RemoveThisTemplate");
contentType.RemoveTemplate(template);
contentTypeService.Save(contentType);

Represents a Language. Installed languages can be found in the settings section.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statement:

using Umbraco.Cms.Core.Models;

Constructors

new Language(GlobalSettings globalSettings, string isoCode)

Constructor for creating a new Language object where the necessary parameter are the global settings as GlobalSettings and the isoCode as a string.

Properties

.CultureInfo

Gets the CultureInfo object for the language.

var language = new Language(globalSettings, "en-US");
CultureInfo cultureInfo = language.CultureInfo;
return cultureInfo;

.CultureName

Gets or sets the culture name of the language.

var language = new Language(globalSettings, "en-US");
string cultureName = language.CultureName;
return cultureName;

.FallbackLanguageId

Gets or sets the identifier of a fallback language. The fallback language can be used in multi-lingual scenarios, to help define fallback strategies when a value does not exist for a requested language.

var language = new Language(globalSettings, "en-US");
int? fallbackLanguageId = language.FallbackLanguageId;
return fallbackLanguageId;

.IsDefault

Gets or sets a value indicating whether the language is the default language.

var language = new Language(globalSettings, "en-US");
bool isDefault = language.IsDefault;
return isDefault;

.IsMandatory

Gets or sets a value indicating whether the language is mandatory. When a language is mandatory, a multi-lingual document cannot be published without that language being published, and unpublishing that language unpublishes the entire document.

var language = new Language(globalSettings, "en-US");
bool isMandatory = language.IsMandatory;
return isMandatory;

.IsoCode

Gets or sets the ISO code of the language.

var language = new Language(globalSettings, "en-US");
return language.IsoCode;

A MediaType is almost the same as a ContentType, that is, a model / data definition for your media nodes

You can set icon, thumbnail and description. It is also possible to add groups and properties.

A Media Type differs from a Document Type in that it has no templates.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statements:

using Umbraco.Cms.Core.Models;
using Umbraco.Cms.Core.Services;

Constructors

new MediaType(IShortStringHelper shortStringHelper, int parentId)

Constructor for creating a new MediaType object where the necessary parameters are a short string helper IShortStringHelper and the Id of the parent MediaType as an Int.

new MediaType(IShortStringHelper shortStringHelper,IMediaType parent)

Constructor for creating a new MediaType object where the necessary parameter are a short string helper IShortStringHelper and the parent MediaType as an IMediaType object.

new MediaType(IShortStringHelper shortStringHelper, IMediaType parent, string alias)

This constructor creates a new MediaType object and requires the following parameters: a short string helper IShortStringHelper and the parent MediaType as an IMediaType object. Additionally, the alias of the MediaType should be provided as a string.

Properties

.Alias

Gets or Sets the Alias as a String of the MediaType.

// Given a `MediaTypeService` object get MediaType by its Id and return Alias
var mediaType = mediaTypeService.Get(1234);
return mediaType.Alias;

.AllowedContentTypes

Gets or Sets an Enumerable list of ContentTypeSort objects of the MediaTypes allowed under the current MediaType.

The ContentTypeSort is an object with a lazy Id, int SortOrder and string Alias used to sort the MediaTypes within the list of AllowedContentTypes.

// Given a `MediaTypeService` object get MediaType by its Id and return AllowedContentTypes
var mediaType = mediaTypeService.Get(1234);
return mediaType.AllowedContentTypes;

.ContentTypeComposition

Gets a list of MediaTypes as IContentTypeComposition objects that make up a composition of PropertyGroups and PropertyTypes for the current MediaType.

The ContentTypeComposition provides a mixin-type functionality in that you can compose a MediaType of one or more other MediaTypes in a complex structure. But please keep in mind that the backoffice does not fully support these complex structures yet

// Given a `MediaTypeService` object get MediaType by its Id and return ContentTypeComposition
var mediaType = mediaTypeService.Get(1234);
return mediaType.ContentTypeComposition;

.CompositionPropertyGroups

Gets a list of all PropertyGroup objects from the composition including PropertyGroups from the current MediaType.

// Given a `MediaTypeService` object get MediaType by its Id and return CompositionPropertyGroups
var mediaType = mediaTypeService.Get(1234);
return mediaType.CompositionPropertyGroups;

.CompositionPropertyTypes

Gets a list of all PropertyType objects from the composition including PropertyTypes from the current MediaType.

// Given a `MediaTypeService` object get MediaType by its Id and return CompositionPropertyTypes
var mediaType = mediaTypeService.Get(1234);
return mediaType.CompositionPropertyTypes;

.CreateDate

Gets or Sets a DateTime object, indicating then the given MediaType was created.

// Given a `MediaTypeService` object get MediaType by its Id and return CreateDate
var mediaType = mediaTypeService.Get(1234);
return mediaType.CreateDate;

.CreatorId

Gets or Sets the Id of the User who created the MediaType.

// Given a `MediaTypeService` object get MediaType by its Id and return the Id of the Creator
var mediaType = mediaTypeService.Get(1234);
return mediaType.CreatorId;

.Description

Gets or Sets the Description as a String for the MediaType.

// Given a `MediaTypeService` object get MediaType by its Id and return the Description
var mediaType = mediaTypeService.Get(1234);
return mediaType.Description;

.Icon

Gets or Sets the Icon as a String for the MediaType.

// Given a `MediaTypeService` object get MediaType by its Id and return the Icon
var mediaType = mediaTypeService.Get(1234);
return mediaType.Icon;

.Id

Retrieves the unique MediaType ID as an Int. This ID is based on a Database identity field and is therefore not safe to reference in code when moved between different instances.

.Key

Gets the Guid assigned to the MediaType during creation. This value is unique, and should never change, even if the content is moved between instances.

// Given a `MediaTypeService` object get MediaType by its Id and return the Key
var mediaType = mediaTypeService.Get(1234);
return mediaType.Key;

.Level

Gets or Sets the given MediaType level in the site hierarchy as an Int. MediaTypes placed at the root of the tree, will return 1, content right underneath will return 2, and so on.

// Given a `MediaTypeService` object get MediaType by its Id and return the Level
var mediaType = mediaTypeService.Get(1234);
return mediaType.Level;

.Name

Gets or Sets the name of the MediaType as a String.

// Given a `MediaTypeService` object get MediaType by its Id and return its Name
var mediaType = mediaTypeService.Get(1234);
return mediaType.Name;

.ParentId

Gets or Sets the parent MediaType Id as an Int.

// Given a `MediaTypeService` object get MediaType by its Id and return the Id of the Parent MediaType
var mediaType = mediaTypeService.Get(1234);
return mediaType.ParentId;

.Path

Gets or Sets the path of the MediaType as a String. This string contains a comma separated list of the ancestor Ids including the current MediaTypes own id at the end of the string.

// Given a `MediaTypeService` object get MediaType by its Id and return the Path
var mediaType = mediaTypeService.Get(1234);
return mediaType.Path;

.PropertyGroups

Gets or Sets a PropertyGroupCollection containing a list of PropertyGroups for the current MediaType.

// Given a `MediaTypeService` object get MediaType by its Id and return PropertyGroups
var mediaType = mediaTypeService.Get(1234);
return mediaType.PropertyGroups;

.PropertyTypes

Gets an Enumerable list of PropertyTypes aggregated for all groups within the current MediaType, as well as PropertyTypes not within a group.

// Given a `MediaTypeService` object get MediaType by its Id and return PropertyTypes
var mediaType = mediaTypeService.Get(1234);
return mediaType.PropertyTypes;

.SortOrder

Gets the given MediaType index, compared to sibling content.

// Given a `MediaTypeService` object get MediaType by its Id and return its SortOrder
var mediaType = mediaTypeService.Get(1234);
return mediaType.SortOrder;

.Thumbnail

Gets or Sets the Thumbnail as a String for the MediaType.

// Given a `MediaTypeService` object get MediaType by its Id and return the Thumbnail
var mediaType = mediaTypeService.Get(1234);
return mediaType.Thumbnail;

Methods

.AddContentType(IContentTypeComposition mediaType)

Adds a new MediaType to the list of composite MediaTypes.

// Given a `MediaTypeService` object get a few MediaTypes by their alias
// and add the 'Meta' and 'SEO' MediaTypes to the composition of the 'Video' MediaType.
var metaContentType = mediaTypeService.Get("meta");
var seoContentType = mediaTypeService.Get("seo");
var videoContentType = mediaTypeService.Get("video");
videoContentType.AddContentType(metaContentType);
videoContentType.AddContentType(seoContentType);
mediaTypeService.Save(videoContentType);

.CompositionAliases()

Returns an Enumerable list of MediaType aliases as String from the current composition.

// Given a `MediaTypeService` object get a MediaType by its alias and loop through CompositionAliases
var mediaType = mediaTypeService.Get("video");
var aliases = mediaType.CompositionAliases();
foreach (var alias in aliases)
{
    string a = alias;
}

.CompositionIds()

Returns an Enumerable list of MediaType Ids as Int from the current composition.

// Given a `MediaTypeService` object get a MediaType by its alias and loop through CompositionIds
var mediaType = mediaTypeService.Get("video");
var ids = mediaType.CompositionIds();
foreach (var id in ids)
{
    int i = id;
}

.ContentTypeCompositionExists(string alias)

Checks if a MediaType with the supplied alias exists in the list of composite MediaTypes.

// Given a `MediaTypeService` object get a MediaType by its alias
// and check if a given MediaType exists in the composition of the 'Video' MediaType.
var mediaType = mediaTypeService.Get("video");
bool result = mediaType.ContentTypeCompositionExists("meta");

.RemoveContentType(string alias)

Removes a MediaType with the supplied alias from the list of composite MediaTypes.

// Given a `MediaTypeService` object get a MediaType by its alias and
// remove the 'Meta' MediaType from its composition.
var mediaType = mediaTypeService.Get("video");
bool success = mediaType.RemoveContentType("meta");
if (success)
    mediaTypeService.Save(mediaType);

.RemovePropertyType(string propertyTypeAlias)

Removes a PropertyType from the current MediaType.

// Given a `MediaTypeService` object get a MediaType by its alias
// and remove a PropertyType from the list of PropertyTypes.
var mediaType = mediaTypeService.Get("video");
mediaType.RemovePropertyType("uploader");
mediaTypeService.Save(mediaType);

Represents a Template file.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statements:

using Umbraco.Cms.Core.Models;

Constructors

new Template(IShortStringHelper shortStringHelper, string name, string alias)

Constructor for creating a new Template object. The necessary parameters include a short String Helper as an IShortStringHelper. The name and alias of the Template must be provided as string values.

Properties

.Alias

Gets the Alias of the File, which is the name without the extension.

var template = new Template(shortStringHelper, "Page", "page");
return template.Alias;

.IsMasterTemplate

Returns true if the template is used as a layout for other templates (that is, it has 'children')

var template = new Template(shortStringHelper,"Page", "page");
return template.IsMasterTemplate;

.MasterTemplateAlias

Returns the alias of the master template if one is set.

var template = new Template(shortStringHelper, "Page", "page");
return template.MasterTemplateAlias;

.MasterTemplateId

Returns the id of the master template if one is set.

var template = new Template(shortStringHelper, "Page", "page");
return template.MasterTemplateId;

.Name

Gets the Name of the File including extension.

var template = new Template(shortStringHelper, "Page", "page");
return template.Name;

Methods

.SetMasterTemplate(ITemplate masterTemplate)

Sets the master template of the template.

// Create a new template
var template = new Template(shortStringHelper, "Page", "page");
// Get a master template 
var masterTemplate = fileService.GetTemplate(1234);
// Set the master template to new created template
template.SetMasterTemplate(masterTemplate);
// Save the new template
fileService.SaveTemplate(template);

Represents a Relation between two items.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statement:

Constructors

new Relation(int parentId, int childId, IRelationType relationType)

Constructor for creating a new Relation object. The necessary parameters are the Id of the parent item as an int, the Id of the child as an int and the relationType as IRelationType.

new Relation(int parentId, int childId, Guid parentObjectType, Guid childObjectType, IRelationType relationType)

A second constructor exists but it should not be used because it is used to reconstruct a relation from the data source.

Properties

.ChildId

Gets or sets the Child Id of the Relation (Destination)

.Comment

Gets or sets a comment for the Relation

.ParentId

Gets or sets the Parent Id of the Relation (Source)

.RelationType

Gets or sets the RelationType for the Relation

.RelationTypeId

Gets the Id of the RelationType that this Relation is based on.

The ServerRegistration class represents a registered server in a multiple-servers environment.

• Namespace: Umbraco.Cms.Core.Models

• Assembly: Umbraco.Core.dll

All samples in this document will require references to the following dll:

• Umbraco.Core.dll

All samples in this document will require the following using statement:

Constructors

new ServerRegistration(string serverAddress, string serverIdentity, DateTime registered)

Constructor for creating a new ServerRegistration object. The necessary parameters are the serverAddress as a string, the serverIdentity as a string and the date and time of registration as a DateTime

new ServerRegistration(int id, string serverAddress, string serverIdentity, DateTime registered, DateTime accessed, bool isActive, bool isSchedulingPublisher)

A second constructor exists but it should not be used because it is used to reconstruct a ServerRegistration from the data source.

Properties

.Accessed

Gets the date and time the registration was last accessed.

.IsActive

Gets or sets a value indicating whether the server is active.

.IsSchedulingPublisher

Gets or sets a value indicating whether the server has the SchedulingPublisher role

.Registered

Gets the date and time the registration was created.

.ServerAddress

Gets or sets the server URL.

.ServerIdentity

Gets or sets the server unique identity.