Class ConfigurationEditor
Represents a data type configuration editor.
Inheritance
Namespace: Umbraco.Cms.Core.PropertyEditors
Assembly: Umbraco.Core.dll
Syntax
[DataContract]
public class ConfigurationEditor : IConfigurationEditorConstructors
View SourceConfigurationEditor()
Initializes a new instance of the Configuration
Declaration
public ConfigurationEditor()ConfigurationEditor(List<ConfigurationField>)
Initializes a new instance of the Configuration
Declaration
protected ConfigurationEditor(List<ConfigurationField> fields)Parameters
| Type | Name | Description |
|---|---|---|
| List<Configuration |
fields |
Properties
View SourceDefaultConfiguration
Gets the default configuration.
Declaration
[DataMember(Name = "defaultConfig")]
public virtual IDictionary<string, object> DefaultConfiguration { get; set; }Property Value
| Type | Description |
|---|---|
| IDictionary<System. |
Fields
Gets the fields.
Declaration
[DataMember(Name = "fields")]
public List<ConfigurationField> Fields { get; }Property Value
| Type | Description |
|---|---|
| List<Configuration |
Methods
View SourceConfigurationAs<TConfiguration>(Object)
Gets the configuration as a typed object.
Declaration
public static TConfiguration ConfigurationAs<TConfiguration>(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| System. |
obj |
Returns
| Type | Description |
|---|---|
| TConfiguration |
Type Parameters
| Name | Description |
|---|---|
| TConfiguration |
Field(String)
Gets a field by its property name.
Declaration
protected ConfigurationField Field(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System. |
name |
Returns
| Type | Description |
|---|---|
| Configuration |
Remarks
Can be used in constructors to add infos to a field that has been defined
by a property marked with the Configuration
FromConfigurationEditor(IDictionary<String, Object>)
Converts values from the configuration editor to configuration data.
Declaration
public virtual IDictionary<string, object> FromConfigurationEditor(IDictionary<string, object> configuration)Parameters
| Type | Name | Description |
|---|---|---|
| IDictionary<System. |
configuration | Values from the configuration editor. |
Returns
| Type | Description |
|---|---|
| IDictionary<System. |
Remarks
Consider this the reverse of ToConfigurationEditor(IDictionary<String, Object>).
FromConfigurationObject(Object, IConfigurationEditorJsonSerializer)
Creates configuration data from a configuration object.
Declaration
public virtual IDictionary<string, object> FromConfigurationObject(object configuration, IConfigurationEditorJsonSerializer configurationEditorJsonSerializer)Parameters
| Type | Name | Description |
|---|---|---|
| System. |
configuration | The configuration object. |
| IConfiguration |
configurationEditorJsonSerializer | The configuration serializer. |
Returns
| Type | Description |
|---|---|
| IDictionary<System. |
FromDatabase(String, IConfigurationEditorJsonSerializer)
Converts a serialized database value into configuration data.
Declaration
public virtual IDictionary<string, object> FromDatabase(string configuration, IConfigurationEditorJsonSerializer configurationEditorJsonSerializer)Parameters
| Type | Name | Description |
|---|---|---|
| System. |
configuration | The serialized database value (JSON format). |
| IConfiguration |
configurationEditorJsonSerializer | The configuration serializer. |
Returns
| Type | Description |
|---|---|
| IDictionary<System. |
ToConfigurationEditor(IDictionary<String, Object>)
Converts the configuration data to values for the configuration editor.
Declaration
public virtual IDictionary<string, object> ToConfigurationEditor(IDictionary<string, object> configuration)Parameters
| Type | Name | Description |
|---|---|---|
| IDictionary<System. |
configuration | The configuration data. |
Returns
| Type | Description |
|---|---|
| IDictionary<System. |
ToConfigurationObject(IDictionary<String, Object>, IConfigurationEditorJsonSerializer)
Creates a configuration object from the configuration data.
Declaration
public virtual object ToConfigurationObject(IDictionary<string, object> configuration, IConfigurationEditorJsonSerializer configurationEditorJsonSerializer)Parameters
| Type | Name | Description |
|---|---|---|
| IDictionary<System. |
configuration | The configuration data. |
| IConfiguration |
configurationEditorJsonSerializer | The configuration serializer. |
Returns
| Type | Description |
|---|---|
| System. |
ToDatabase(IDictionary<String, Object>, IConfigurationEditorJsonSerializer)
Converts configuration data into a serialized database value.
Declaration
public virtual string ToDatabase(IDictionary<string, object> configuration, IConfigurationEditorJsonSerializer configurationEditorJsonSerializer)Parameters
| Type | Name | Description |
|---|---|---|
| IDictionary<System. |
configuration | |
| IConfiguration |
configurationEditorJsonSerializer |
Returns
| Type | Description |
|---|---|
| System. |
ToValueEditor(IDictionary<String, Object>)
Converts the configuration data to values for the value editor.
Declaration
public virtual IDictionary<string, object> ToValueEditor(IDictionary<string, object> configuration)Parameters
| Type | Name | Description |
|---|---|---|
| IDictionary<System. |
configuration | The configuration data. |
Returns
| Type | Description |
|---|---|
| IDictionary<System. |
Validate(IDictionary<String, Object>)
Performs validation of configuration data.
Declaration
public virtual IEnumerable<ValidationResult> Validate(IDictionary<string, object> configuration)Parameters
| Type | Name | Description |
|---|---|---|
| IDictionary<System. |
configuration | The configuration data to validate. |
Returns
| Type | Description |
|---|---|
| IEnumerable<System. |
One or more System. |