London Dev Meetup Rescheduled! Due to unavoidable reasons, the event has been moved to 21st May. Speakers remain the same—any changes will be communicated. Seats are limited—register here to secure your spot!

Interface ISettingsDictionary

A dictionary of settings used for adding configuration aspects to children of containers.

Inherited Members
System.Collections.Generic.IDictionary<System.String, System.Object>.ContainsKey(System.String)
System.Collections.Generic.IDictionary<System.String, System.Object>.Add(System.String, System.Object)
System.Collections.Generic.IDictionary<System.String, System.Object>.Remove(System.String)
System.Collections.Generic.IDictionary<System.String, System.Object>.TryGetValue(System.String, System.Object)
System.Collections.Generic.IDictionary<System.String, System.Object>.Item[System.String]
System.Collections.Generic.IDictionary<System.String, System.Object>.Keys
System.Collections.Generic.IDictionary<System.String, System.Object>.Values
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.Add(System.Collections.Generic.KeyValuePair<System.String, System.Object>)
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.Clear()
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.Contains(System.Collections.Generic.KeyValuePair<System.String, System.Object>)
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.CopyTo(System.Collections.Generic.KeyValuePair<System.String, System.Object>[], System.Int32)
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.Remove(System.Collections.Generic.KeyValuePair<System.String, System.Object>)
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.Count
System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.IsReadOnly
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.Object>>.GetEnumerator()
System.Collections.IEnumerable.GetEnumerator()
Namespace: EPiServer.Shell.ViewComposition
Assembly: EPiServer.Shell.dll
Version: 10.10.4
Syntax
public interface ISettingsDictionary : IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IEnumerable

Methods

Add(Setting)

Adds the specified Setting object containing persistance information.

Declaration
void Add(Setting setting)
Parameters
Type Name Description
Setting setting

The setting object to add.

AddSettings(IDictionary<String, Object>, Boolean)

Adds the settings specified in

values

to the settings collection.

Declaration
void AddSettings(IDictionary<string, object> values, bool personalizable)
Parameters
Type Name Description
System.Collections.Generic.IDictionary<System.String, System.Object> values

The values.

System.Boolean personalizable

if the settings should be personalizable.

Copy()

Creates a deep copy of the settings dictionary.

Declaration
ISettingsDictionary Copy()
Returns
Type Description
ISettingsDictionary

The copied dictionary.

GetPersonalizableSettings()

Gets the settings that are to be persisted to storage.

Declaration
IDictionary<string, object> GetPersonalizableSettings()
Returns
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

An System.Collections.IDictionary with the settings that can be personalized.

MergeRange(Setting[])

Merges a range of settings, overwriting current values if existing.

Declaration
void MergeRange(Setting[] settings)
Parameters
Type Name Description
Setting[] settings

The settings.

Extension Methods