AI OnAI Off

Class PropertyEditorSettings

Container class to be able to define editor settings on web control EPiServer:Property

Inheritance
System.Object
PropertyEditorSettings
PropertyRenderSettings
Implements
System.Web.UI.IAttributeAccessor
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Web.WebControls
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
public class PropertyEditorSettings : IAttributeAccessor
Remarks

These settings can vary from property to property, consult the documentation for each property for more details on custom properties.

Constructors

PropertyEditorSettings()

Initializes a new instance of the PropertyEditorSettings class.

Declaration
public PropertyEditorSettings()

PropertyEditorSettings(String)

Initializes a new instance of the PropertyEditorSettings class.

Declaration
public PropertyEditorSettings(string json)
Parameters
Type Name Description
System.String json

JSON values that will be used to initialize the Settings collection.

Properties

ObjectSerializerFactory

Gets or sets the object serializer to use when serializing to Json.

Declaration
protected Injected<IObjectSerializerFactory> ObjectSerializerFactory { get; set; }
Property Value
Type Description
Injected<IObjectSerializerFactory>

The object serializer.

Settings

The underlying dictionary used to store all settings

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

Methods

FromJson(String)

Merges the data from the JSON string onto the Settings collection.

Declaration
protected void FromJson(string json)
Parameters
Type Name Description
System.String json

string in JSON format.

GetAttribute(String)

Declaration
public string GetAttribute(string key)
Parameters
Type Name Description
System.String key
Returns
Type Description
System.String

HasSetting(String)

Determines whether the Settings collection has the setting specified by the key.

Declaration
public bool HasSetting(string key)
Parameters
Type Name Description
System.String key

The key.
Returns
Type Description
System.Boolean

true if Settings collection has the setting; otherwise, false.

HasSettings()

Determines whether the Settings collection has any settings.

Declaration
public bool HasSettings()
Returns
Type Description
System.Boolean

true if the Settings collection has settings; otherwise, false.

RemoveAttribute(String)

Removes the attribute specified by the key.

Declaration
public void RemoveAttribute(string key)
Parameters
Type Name Description
System.String key

The key.

SetAttribute(String, String)

Declaration
public void SetAttribute(string key, string value)
Parameters
Type Name Description
System.String key
System.String value

ToJson()

Serializes the Settings collection to JSON

Declaration
public string ToJson()
Returns
Type Description
System.String

string in JSON format.

Implements

System.Web.UI.IAttributeAccessor

Extension Methods