View Source

Class ConfigurationField

Represents a datatype configuration field for editing.

Inheritance
System.Object
Namespace: Umbraco.Cms.Core.PropertyEditors
Assembly: Umbraco.Core.dll
Syntax
[DataContract]
public class ConfigurationField

Constructors

View Source

ConfigurationField()

Initializes a new instance of the ConfigurationField class.

Declaration
public ConfigurationField()
View Source

ConfigurationField(IValueValidator[])

Initializes a new instance of the ConfigurationField class.

Declaration
public ConfigurationField(params IValueValidator[] validators)
Parameters
Type Name Description
IValueValidator[] validators

Properties

View Source

Config

Gets or sets extra configuration properties for the editor.

Declaration
[DataMember(Name = "config")]
public IDictionary<string, object> Config { get; set; }
Property Value
Type Description
IDictionary<System.String, System.Object>
View Source

Description

Gets or sets the description of the field.

Declaration
[DataMember(Name = "description")]
public string Description { get; set; }
Property Value
Type Description
System.String
View Source

HideLabel

Gets or sets a value indicating whether to hide the label of the field.

Declaration
[DataMember(Name = "hideLabel")]
public bool HideLabel { get; set; }
Property Value
Type Description
System.Boolean
View Source

Key

Gets or sets the key of the field.

Declaration
[DataMember(Name = "key", IsRequired = true)]
public string Key { get; set; }
Property Value
Type Description
System.String
View Source

Name

Gets or sets the name of the field.

Declaration
[DataMember(Name = "label", IsRequired = true)]
public string Name { get; set; }
Property Value
Type Description
System.String
View Source

PropertyName

Gets or sets the property name of the field.

Declaration
public string PropertyName { get; set; }
Property Value
Type Description
System.String
View Source

PropertyType

Gets or sets the property CLR type of the field.

Declaration
public Type? PropertyType { get; set; }
Property Value
Type Description
System.Nullable<Type>
View Source

SortOrder

Gets or sets the sort order of the field.

Declaration
[DataMember(Name = "sortOrder")]
public int SortOrder { get; set; }
Property Value
Type Description
System.Int32
View Source

Validators

Gets the validators of the field.

Declaration
[DataMember(Name = "validation")]
public List<IValueValidator> Validators { get; }
Property Value
Type Description
List<IValueValidator>
View Source

View

Gets or sets the view to used in the editor.

Declaration
[DataMember(Name = "view", IsRequired = true)]
public string View { get; set; }
Property Value
Type Description
System.String
Remarks

Can be the full virtual path, or the relative path to the Umbraco folder, or a simple view name which will map to ~/Views/PreValueEditors/{view}.html.