Search Results for

    Show / Hide Table of Contents

    Class ConfigurationEditor<TConfiguration>

    Represents a data type configuration editor with a typed configuration.

    Inheritance
    System.Object
    Namespace: Umbraco.Cms.Core.PropertyEditors
    Assembly: cs.temp.dll.dll
    Syntax
    public abstract class ConfigurationEditor<TConfiguration> : ConfigurationEditor where TConfiguration : new()
    Type Parameters
    Name Description
    TConfiguration

    Constructors

    ConfigurationEditor(IIOHelper)

    Initializes a new instance of the ConfigurationEditor<TConfiguration> class.

    Declaration
    protected ConfigurationEditor(IIOHelper ioHelper)
    Parameters
    Type Name Description
    IIOHelper ioHelper

    Properties

    DefaultConfiguration

    Declaration
    public override IDictionary<string, object> DefaultConfiguration { get; }
    Property Value
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>

    DefaultConfigurationObject

    Declaration
    public override object DefaultConfigurationObject { get; }
    Property Value
    Type Description
    System.Object

    Methods

    FromConfigurationEditor(IDictionary<String, Object>, TConfiguration)

    Converts the configuration posted by the editor.

    Declaration
    public virtual TConfiguration FromConfigurationEditor(IDictionary<string, object> editorValues, TConfiguration configuration)
    Parameters
    Type Name Description
    System.Collections.Generic.IDictionary<System.String, System.Object> editorValues

    The configuration object posted by the editor.

    TConfiguration configuration

    The current configuration object.

    Returns
    Type Description
    TConfiguration

    FromConfigurationEditor(IDictionary<String, Object>, Object)

    Declaration
    public sealed override object FromConfigurationEditor(IDictionary<string, object> editorValues, object configuration)
    Parameters
    Type Name Description
    System.Collections.Generic.IDictionary<System.String, System.Object> editorValues
    System.Object configuration
    Returns
    Type Description
    System.Object

    FromDatabase(String, IConfigurationEditorJsonSerializer)

    Declaration
    public override object FromDatabase(string configuration, IConfigurationEditorJsonSerializer configurationEditorJsonSerializer)
    Parameters
    Type Name Description
    System.String configuration
    IConfigurationEditorJsonSerializer configurationEditorJsonSerializer
    Returns
    Type Description
    System.Object

    IsConfiguration(Object)

    Declaration
    public override bool IsConfiguration(object obj)
    Parameters
    Type Name Description
    System.Object obj
    Returns
    Type Description
    System.Boolean

    ToConfigurationEditor(TConfiguration)

    Converts configuration values to values for the editor.

    Declaration
    public virtual Dictionary<string, object> ToConfigurationEditor(TConfiguration configuration)
    Parameters
    Type Name Description
    TConfiguration configuration

    The configuration.

    Returns
    Type Description
    System.Collections.Generic.Dictionary<System.String, System.Object>

    ToConfigurationEditor(Object)

    Declaration
    public sealed override IDictionary<string, object> ToConfigurationEditor(object configuration)
    Parameters
    Type Name Description
    System.Object configuration
    Returns
    Type Description
    System.Collections.Generic.IDictionary<System.String, System.Object>
    In This Article
    • Constructors
      • ConfigurationEditor(IIOHelper)
    • Properties
      • DefaultConfiguration
      • DefaultConfigurationObject
    • Methods
      • FromConfigurationEditor(IDictionary<String, Object>, TConfiguration)
      • FromConfigurationEditor(IDictionary<String, Object>, Object)
      • FromDatabase(String, IConfigurationEditorJsonSerializer)
      • IsConfiguration(Object)
      • ToConfigurationEditor(TConfiguration)
      • ToConfigurationEditor(Object)
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX