Search Results for

    Show / Hide Table of Contents
    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

    View Source

    Alias

    Gets the alias of the editor.

    Declaration
    string Alias { get; }
    Property Value
    Type Description
    System.String
    View Source

    DefaultConfiguration

    Gets the configuration for the value editor.

    Declaration
    IDictionary<string, object>? DefaultConfiguration { get; }
    Property Value
    Type Description
    System.Nullable<IDictionary<System.String, System.Object>>
    View Source

    IsDeprecated

    Gets a value indicating whether the editor is deprecated.

    Declaration
    bool IsDeprecated { get; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Deprecated editors are supported but not proposed in the UI.

    View Source

    PropertyIndexValueFactory

    Gets the index value factory for the editor.

    Declaration
    IPropertyIndexValueFactory PropertyIndexValueFactory { get; }
    Property Value
    Type Description
    IPropertyIndexValueFactory
    View Source

    SupportsConfigurableElements

    Declaration
    virtual bool SupportsConfigurableElements { get; }
    Property Value
    Type Description
    System.Boolean
    View Source

    SupportsReadOnly

    Declaration
    virtual bool SupportsReadOnly { get; }
    Property Value
    Type Description
    System.Boolean

    Methods

    View Source

    CanMergePartialPropertyValues(IPropertyType)

    Determines if the value editor needs to perform MergePartialPropertyValueForCulture(Object, Object, String) for a given property type.

    Declaration
    virtual bool CanMergePartialPropertyValues(IPropertyType propertyType)
    Parameters
    Type Name Description
    IPropertyType propertyType
    Returns
    Type Description
    System.Boolean
    View Source

    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.

    View Source

    GetValueEditor()

    Gets a value editor.

    Declaration
    IDataValueEditor GetValueEditor()
    Returns
    Type Description
    IDataValueEditor
    View Source

    GetValueEditor(Object)

    Gets a configured value editor.

    Declaration
    IDataValueEditor GetValueEditor(object configurationObject)
    Parameters
    Type Name Description
    System.Object configurationObject
    Returns
    Type Description
    IDataValueEditor
    View Source

    MergePartialPropertyValueForCulture(Object, Object, String)

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

    Declaration
    virtual object MergePartialPropertyValueForCulture(object sourceValue, object targetValue, string culture)
    Parameters
    Type Name Description
    System.Object sourceValue

    The source property value.

    System.Object targetValue

    The target property value.

    System.String culture

    The culture (or null for invariant).

    Returns
    Type Description
    System.Object

    The result of the merge operation.

    View Source

    MergeVariantInvariantPropertyValue(Object, Object, Boolean, HashSet<String>)

    Declaration
    virtual object MergeVariantInvariantPropertyValue(object sourceValue, object targetValue, bool canUpdateInvariantData, HashSet<string> allowedCultures)
    Parameters
    Type Name Description
    System.Object sourceValue
    System.Object targetValue
    System.Boolean canUpdateInvariantData
    HashSet<System.String> allowedCultures
    Returns
    Type Description
    System.Object
    • Improve this Doc
    • View Source
    In This Article
    • Properties
      • Alias
      • DefaultConfiguration
      • IsDeprecated
      • PropertyIndexValueFactory
      • SupportsConfigurableElements
      • SupportsReadOnly
    • Methods
      • CanMergePartialPropertyValues(IPropertyType)
      • GetConfigurationEditor()
      • GetValueEditor()
      • GetValueEditor(Object)
      • MergePartialPropertyValueForCulture(Object, Object, String)
      • MergeVariantInvariantPropertyValue(Object, Object, Boolean, HashSet<String>)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX