Interface IProperty

Namespace: Umbraco.Cms.Core.Models

Assembly: Umbraco.Core.dll

Syntax

public interface IProperty : IEntity, IDeepCloneable, IRememberBeingDirty, ICanBeDirty

Properties

View Source

Alias

Returns the Alias of the PropertyType, which this Property is based on

Declaration

string Alias { get; }

Property Value

Type	Description
string

View Source

PropertyType

Returns the PropertyType, which this Property is based on

Declaration

IPropertyType PropertyType { get; }

Property Value

Type	Description
IPropertyType

View Source

PropertyTypeId

Declaration

int PropertyTypeId { get; }

Property Value

Type	Description
int

View Source

ValueStorageType

Declaration

ValueStorageType ValueStorageType { get; }

Property Value

Type	Description
ValueStorageType

View Source

Values

Gets the list of values.

Declaration

IReadOnlyCollection<IPropertyValue> Values { get; set; }

Property Value

Type	Description
IReadOnlyCollection<IPropertyValue>

Methods

View Source

GetValue(string?, string?, bool)

Gets the value.

Declaration

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

Parameters

Type	Name	Description
string	culture
string	segment
bool	published

Returns

Type	Description
object

View Source

PublishPartialValues(IDataEditor, string?)

Declaration

void PublishPartialValues(IDataEditor dataEditor, string? culture)

Parameters

Type	Name	Description
IDataEditor	dataEditor
string	culture

View Source

PublishValues(string?, string)

Declaration

void PublishValues(string? culture = "*", string segment = "*")

Parameters

Type	Name	Description
string	culture
string	segment

View Source

SetValue(object?, string?, string?)

Sets a value.

Declaration

bool SetValue(object? value, string? culture = null, string? segment = null)

Parameters

Type	Name	Description
object	value
string	culture
string	segment

Returns

Type	Description
bool	true if the value was set (updated), false otherwise.

Remarks

A false return value does not indicate failure, but rather that the property value was not changed (i.e. the value passed in was equal to the current property value).

View Source

UnpublishValues(string?, string)

Declaration

void UnpublishValues(string? culture = "*", string segment = "*")

Parameters

Type	Name	Description
string	culture
string	segment