View Source

Interface IDataEditor

Represents a data editor.

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Core.dll

Syntax

public interface IDataEditor : IDiscoverable

Remarks

This is the base interface for parameter and property editors.

Properties

Alias

Gets the alias of the editor.

Declaration

string Alias { get; }

Property Value

Type	Description
string

DefaultConfiguration

Gets the configuration for the value editor.

Declaration

IDictionary<string, object>? DefaultConfiguration { get; }

Property Value

Type	Description
IDictionary<string, object>

IsDeprecated

Gets a value indicating whether the editor is deprecated.

Declaration

bool IsDeprecated { get; }

Property Value

Type	Description
bool

Remarks

Deprecated editors are supported but not proposed in the UI.

PropertyIndexValueFactory

Gets the index value factory for the editor.

Declaration

IPropertyIndexValueFactory PropertyIndexValueFactory { get; }

Property Value

Type	Description
IPropertyIndexValueFactory

SupportsConfigurableElements

Declaration

bool SupportsConfigurableElements { get; }

Property Value

Type	Description
bool

SupportsReadOnly

Declaration

bool SupportsReadOnly { get; }

Property Value

Type	Description
bool

Methods

CanMergePartialPropertyValues(IPropertyType)

Determines if the value editor needs to perform MergePartialPropertyValueForCulture(object?, object?, string?) for a given property type.

Declaration

bool CanMergePartialPropertyValues(IPropertyType propertyType)

Parameters

Type	Name	Description
IPropertyType	propertyType

Returns

Type	Description
bool

GetConfigurationEditor()

Gets an editor to edit the value editor configuration.

Declaration

IConfigurationEditor GetConfigurationEditor()

Returns

Type	Description
IConfigurationEditor

Remarks

Is expected to throw if the editor does not support being configured, e.g. for most parameter editors.

GetValueEditor()

Gets a value editor.

Declaration

IDataValueEditor GetValueEditor()

Returns

Type	Description
IDataValueEditor

GetValueEditor(object?)

Gets a configured value editor.

Declaration

IDataValueEditor GetValueEditor(object? configurationObject)

Parameters

Type	Name	Description
object	configurationObject

Returns

Type	Description
IDataValueEditor

MergePartialPropertyValueForCulture(object?, object?, string?)

Partially merges a source property value into a target property value for a given culture.

Declaration

object? MergePartialPropertyValueForCulture(object? sourceValue, object? targetValue, string? culture)

Parameters

Type	Name	Description
object	sourceValue	The source property value.
object	targetValue	The target property value.
string	culture	The culture (or null for invariant).

Returns

Type	Description
object	The result of the merge operation.

MergeVariantInvariantPropertyValue(object?, object?, bool, HashSet<string>)

Declaration

object? MergeVariantInvariantPropertyValue(object? sourceValue, object? targetValue, bool canUpdateInvariantData, HashSet<string> allowedCultures)

Parameters

Type	Name	Description
object	sourceValue
object	targetValue
bool	canUpdateInvariantData
HashSet<string>	allowedCultures

Returns

Type	Description
object