View Source

Class PublishedDataType

Represents a published data type.

Inheritance

object

Namespace: Umbraco.Cms.Core.Models.PublishedContent

Assembly: Umbraco.Core.dll

Syntax

public class PublishedDataType

Remarks

Instances of the PublishedDataType class are immutable, ie if the data type changes, then a new class needs to be created.

These instances should be created by an IPublishedContentTypeFactory.

Constructors

PublishedDataType(int, string, string?, Lazy<object?>)

Initializes a new instance of the PublishedDataType class.

Declaration

public PublishedDataType(int id, string editorAlias, string? editorUiAlias, Lazy<object?> lazyConfiguration)

Parameters

Type	Name	Description
int	id
string	editorAlias
string	editorUiAlias
Lazy<object>	lazyConfiguration

Properties

ConfigurationObject

Gets the data type configuration object.

Declaration

public object? ConfigurationObject { get; }

Property Value

Type	Description
object

EditorAlias

Gets the data type editor alias.

Declaration

public string EditorAlias { get; }

Property Value

Type	Description
string

EditorUiAlias

Gets the data type editor UI alias.

Declaration

public string EditorUiAlias { get; }

Property Value

Type	Description
string

Id

Gets the datatype identifier.

Declaration

public int Id { get; }

Property Value

Type	Description
int

Methods

ConfigurationAs<T>()

Gets the configuration object.

Declaration

public T? ConfigurationAs<T>() where T : class

Returns

Type	Description
T

Type Parameters

Name	Description
T	The expected type of the configuration object.

Exceptions

Type	Condition
InvalidCastException	When the datatype configuration is not of the expected type.