View Source

Interface IPropertyType

Namespace: Umbraco.Cms.Core.Models

Assembly: Umbraco.Core.dll

Syntax

public interface IPropertyType : IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty

Properties

Alias

Gets of sets the alias of the property type.

Declaration

string Alias { get; set; }

Property Value

Type	Description
string

DataTypeId

Gets or sets the identifier of the datatype for this property type.

Declaration

int DataTypeId { get; set; }

Property Value

Type	Description
int

DataTypeKey

Gets or sets the Guid unique identifier of the datatype for this property type.

Declaration

Guid DataTypeKey { get; set; }

Property Value

Type	Description
Guid

Description

Gets of sets the description of the property type.

Declaration

string? Description { get; set; }

Property Value

Type	Description
string

LabelOnTop

Gets or sets a value indicating whether the label of this property type should be displayed on top.

Declaration

bool LabelOnTop { get; set; }

Property Value

Type	Description
bool

Mandatory

Gets of sets a value indicating whether a value for this property type is required.

Declaration

bool Mandatory { get; set; }

Property Value

Type	Description
bool

MandatoryMessage

Gets or sets the custom validation message used when a value for this PropertyType is required

Declaration

string? MandatoryMessage { get; set; }

Property Value

Type	Description
string

Name

Gets of sets the name of the property type.

Declaration

string Name { get; set; }

Property Value

Type	Description
string

PropertyEditorAlias

Gets or sets the alias of the property editor for this property type.

Declaration

string PropertyEditorAlias { get; set; }

Property Value

Type	Description
string

PropertyGroupId

Gets or sets the identifier of the property group this property type belongs to.

Declaration

Lazy<int>? PropertyGroupId { get; set; }

Property Value

Type	Description
Lazy<int>

Remarks

For generic properties, the value is null.

SortOrder

Gets of sets the sort order of the property type.

Declaration

int SortOrder { get; set; }

Property Value

Type	Description
int

SupportsPublishing

Declaration

bool SupportsPublishing { get; set; }

Property Value

Type	Description
bool

ValidationRegExp

Gets or sets the regular expression validating the property values.

Declaration

string? ValidationRegExp { get; set; }

Property Value

Type	Description
string

ValidationRegExpMessage

Gets or sets the custom validation message used when a pattern for this PropertyType must be matched

Declaration

string? ValidationRegExpMessage { get; set; }

Property Value

Type	Description
string

ValueStorageType

Gets or sets the database type for storing value for this property type.

Declaration

ValueStorageType ValueStorageType { get; set; }

Property Value

Type	Description
ValueStorageType

Variations

Gets or sets the content variation of the property type.

Declaration

ContentVariation Variations { get; set; }

Property Value

Type	Description
ContentVariation

Methods

SupportsVariation(string?, string?, bool)

Determines whether the property type supports a combination of culture and segment.

Declaration

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

Parameters

Type	Name	Description
string	culture	The culture.
string	segment	The segment.
bool	wildcards	A value indicating whether wildcards are valid.

Returns

Type	Description
bool