Virtual Happy Hour this month, Jun 28, we'll be getting a sneak preview at our soon to launch SaaS CMS!

Try our conversational search powered by Generative AI!

Class PropertySettingsContainer

Used as aggregate root for the settings objects for a property or propertyControl

Inheritance
System.Object
PropertySettingsContainer
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.Core.PropertySettings
Assembly: EPiServer.dll
Version: 11.20.7
Syntax
[EPiServerDataTable(TableName = "tblSystemBigTable")]
public class PropertySettingsContainer

Constructors

PropertySettingsContainer()

Initializes a new instance of the PropertySettingsContainer class.

Declaration
public PropertySettingsContainer()

PropertySettingsContainer(Guid)

Initializes a new instance of the PropertySettingsContainer class.

Declaration
public PropertySettingsContainer(Guid id)
Parameters
Type Name Description
System.Guid id

The id.

Properties

Id

Gets or sets the id.

Declaration
public Guid Id { get; set; }
Property Value
Type Description
System.Guid

The id.

PropertyControl

Gets or sets the property control used when rendering a control for a property.

Declaration
public Type PropertyControl { get; set; }
Property Value
Type Description
System.Type

The property control.

PropertyControlTypeName

Gets the assembly qualified name of the property control type. Used for data storage

Declaration
public string PropertyControlTypeName { get; set; }
Property Value
Type Description
System.String

The name of the property control type.

Remarks

This should be set to the FullName property of the Type class.

Settings

Gets a dictionary of settings for all associated types.

Declaration
public Dictionary<string, PropertySettingsWrapper> Settings { get; protected set; }
Property Value
Type Description
System.Collections.Generic.Dictionary<System.String, PropertySettingsWrapper>

The settings.

Methods

AddSettings(PropertySettingsWrapper)

Adds settings to the collection.

Declaration
public void AddSettings(PropertySettingsWrapper settings)
Parameters
Type Name Description
PropertySettingsWrapper settings

The settings object to add.

Copy()

Copies this instance.

Declaration
public PropertySettingsContainer Copy()
Returns
Type Description
PropertySettingsContainer

A copy of this instance.

Remarks

The copy does a deep copy of local settings while global settings reuse the same objects. The copy it not saved to the database.

GetSetting(Type)

Gets a settings instance of a specified type.

Declaration
public PropertySettingsWrapper GetSetting(Type type)
Parameters
Type Name Description
System.Type type

The type.

Returns
Type Description
PropertySettingsWrapper

RemoveSettings(PropertySettingsWrapper)

Removes the settings.

Declaration
public void RemoveSettings(PropertySettingsWrapper settings)
Parameters
Type Name Description
PropertySettingsWrapper settings

The settings wrapper.

RemoveSettings(Guid)

Removes the settings with the given id.

Declaration
public bool RemoveSettings(Guid id)
Parameters
Type Name Description
System.Guid id

The id.

Returns
Type Description
System.Boolean

True if the settings was found and removed; otherwise false.

RemoveSettings(Type)

Removes any existing settings with the specified type.

Declaration
public void RemoveSettings(Type settingsType)
Parameters
Type Name Description
System.Type settingsType

Type of the settings.

Extension Methods