View Source

Interface IContentTypeBase

Defines the base for a ContentType with properties that are shared between ContentTypes and MediaTypes.

Namespace: Umbraco.Core.Models

Assembly: Umbraco.Core.dll

Syntax

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

Properties

Alias

Gets or Sets the Alias of the ContentType

Declaration

string Alias { get; set; }

Property Value

Type	Description
System.String

AllowedAsRoot

Gets or Sets a boolean indicating whether this ContentType is allowed at the root

Declaration

bool AllowedAsRoot { get; set; }

Property Value

Type	Description
System.Boolean

AllowedContentTypes

Gets or Sets a list of integer Ids of the ContentTypes allowed under the ContentType

Declaration

IEnumerable<ContentTypeSort> AllowedContentTypes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ContentTypeSort>

Description

Gets or Sets the Description for the ContentType

Declaration

string Description { get; set; }

Property Value

Type	Description
System.String

Icon

Gets or sets the icon for the content type. The value is a CSS class name representing the icon (eg. icon-home) along with an optional CSS class name representing the color (eg. icon-blue). Put together, the value for this scenario would be icon-home color-blue.

If a class name for the color isn't specified, the icon color will default to black.

Declaration

string Icon { get; set; }

Property Value

Type	Description
System.String

IsContainer

Gets or Sets a boolean indicating whether this ContentType is a Container

Declaration

bool IsContainer { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

ContentType Containers doesn't show children in the tree, but rather in grid-type view.

IsElement

Gets or sets a value indicating whether this content type is for an element.

Declaration

bool IsElement { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

By default a content type is for a true media, member or document, but it can also be for an element, ie a subset that can for instance be used in nested content.

NoGroupPropertyTypes

Gets or sets the local property types that do not belong to a group.

Declaration

IEnumerable<PropertyType> NoGroupPropertyTypes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<PropertyType>

PropertyGroups

Gets or sets the local property groups.

Declaration

PropertyGroupCollection PropertyGroups { get; set; }

Property Value

Type	Description
PropertyGroupCollection

PropertyTypes

Gets all local property types all local property groups or ungrouped.

Declaration

IEnumerable<PropertyType> PropertyTypes { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<PropertyType>

Thumbnail

Gets or Sets the Thumbnail for the ContentType

Declaration

string Thumbnail { get; set; }

Property Value

Type	Description
System.String

Variations

Gets or sets the content variation of the content type.

Declaration

ContentVariation Variations { get; set; }

Property Value

Type	Description
ContentVariation

Methods

AddPropertyGroup(String)

Adds a property group with the alias based on the specified groupName.

Declaration

[Obsolete("Use AddPropertyGroup(alias, name) instead to explicitly set the alias (note the slighty different parameter order).")]
bool AddPropertyGroup(string groupName)

Parameters

Type	Name	Description
System.String	groupName	Name of the group.

Returns

Type	Description
System.Boolean	Returns true if a property group with specified groupName was added; otherwise, false.

Remarks

This method will also check if a group already exists with the same alias.

AddPropertyGroup(String, String)

Adds a property group with the specified name and alias.

Declaration

bool AddPropertyGroup(string alias, string name)

Parameters

Type	Name	Description
System.String	alias	The alias.
System.String	name	Name of the group.

Returns

Type	Description
System.Boolean	Returns true if a property group with specified alias was added; otherwise, false.

Remarks

This method will also check if a group already exists with the same alias.

AddPropertyType(PropertyType)

Adds a PropertyType, which does not belong to a PropertyGroup.

Declaration

bool AddPropertyType(PropertyType propertyType)

Parameters

Type	Name	Description
PropertyType	propertyType	PropertyType to add

Returns

Type	Description
System.Boolean	Returns True if PropertyType was added, otherwise False

AddPropertyType(PropertyType, String)

Adds the property type to the specified property group (creates a new group if not found).

Declaration

[Obsolete("Use AddPropertyType(propertyType, groupAlias, groupName) instead to explicitly set the alias of the group (note the slighty different parameter order).")]
bool AddPropertyType(PropertyType propertyType, string propertyGroupName)

Parameters

Type	Name	Description
PropertyType	propertyType	The property type to add.
System.String	propertyGroupName	The name of the property group to add the property type to.

Returns

Type	Description
System.Boolean	Returns true if the property type was added; otherwise, false.

AddPropertyType(PropertyType, String, String)

Adds the property type to the specified property group (creates a new group if not found and a name is specified).

Declaration

bool AddPropertyType(PropertyType propertyType, string groupAlias, string groupName)

Parameters

Type	Name	Description
PropertyType	propertyType	The property type to add.
System.String	groupAlias	The alias of the property group to add the property type to.
System.String	groupName	The name of the property group to create when not found.

Returns

Type	Description
System.Boolean	Returns true if the property type was added; otherwise, false.

MovePropertyType(String, String)

Moves a PropertyType to a specified PropertyGroup

Declaration

bool MovePropertyType(string propertyTypeAlias, string propertyGroupName)

Parameters

Type	Name	Description
System.String	propertyTypeAlias	Alias of the PropertyType to move
System.String	propertyGroupName	Name of the PropertyGroup to move the PropertyType to

Returns

Type	Description
System.Boolean

PropertyTypeExists(String)

Checks whether a PropertyType with a given alias already exists

Declaration

bool PropertyTypeExists(string propertyTypeAlias)

Parameters

Type	Name	Description
System.String	propertyTypeAlias	Alias of the PropertyType

Returns

Type	Description
System.Boolean	Returns True if a PropertyType with the passed in alias exists, otherwise False

RemovePropertyGroup(String)

Removes a property group from the current content type.

Declaration

void RemovePropertyGroup(string propertyGroupName)

Parameters

Type	Name	Description
System.String	propertyGroupName	Name of the PropertyGroup to remove

RemovePropertyType(String)

Removes a PropertyType from the current ContentType

Declaration

void RemovePropertyType(string propertyTypeAlias)

Parameters

Type	Name	Description
System.String	propertyTypeAlias	Alias of the PropertyType to remove

SupportsPropertyVariation(String, String, Boolean)

Validates that a combination of culture and segment is valid for the content type properties.

Declaration

bool SupportsPropertyVariation(string culture, string segment, bool wildcards = false)

Parameters

Type	Name	Description
System.String	culture	The culture.
System.String	segment	The segment.
System.Boolean	wildcards	A value indicating whether wildcard are supported.

Returns

Type	Description
System.Boolean	True if the combination is valid; otherwise false.

Remarks

The combination must be valid for properties of the content type. For instance, if the content type varies by culture, then an invariant culture is valid, because some properties may be invariant. On the other hand, if the content type is invariant, then a variant culture is invalid, because no property could possibly vary by culture.

SupportsVariation(String, String, Boolean)

Validates that a combination of culture and segment is valid for the content type.

Declaration

bool SupportsVariation(string culture, string segment, bool wildcards = false)

Parameters

Type	Name	Description
System.String	culture	The culture.
System.String	segment	The segment.
System.Boolean	wildcards	A value indicating whether wildcard are supported.

Returns

Type	Description
System.Boolean	True if the combination is valid; otherwise false.

Remarks

The combination must match the content type variation exactly. For instance, if the content type varies by culture, then an invariant culture would be invalid.

ToSimple()

Gets an ISimpleContentType corresponding to this content type.

Declaration

ISimpleContentType ToSimple()

Returns

Type	Description
ISimpleContentType