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

ConfigurationField()

Initializes a new instance of the ConfigurationField class.

Declaration

public ConfigurationField()

ConfigurationField(IValueValidator[])

Initializes a new instance of the ConfigurationField class.

Declaration

public ConfigurationField(params IValueValidator[] validators)

Parameters

Type	Name	Description
IValueValidator[]	validators

Properties

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>

Description

Gets or sets the description of the field.

Declaration

[DataMember(Name = "description")]
public string Description { get; set; }

Property Value

Type	Description
System.String

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

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

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

PropertyName

Gets or sets the property name of the field.

Declaration

public string PropertyName { get; set; }

Property Value

Type	Description
System.String

PropertyType

Gets or sets the property CLR type of the field.

Declaration

public Type? PropertyType { get; set; }

Property Value

Type	Description
System.Nullable<Type>

Validators

Gets the validators of the field.

Declaration

[DataMember(Name = "validation")]
public List<IValueValidator> Validators { get; }

Property Value

Type	Description
List<IValueValidator>

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.