November Happy Hour will be moved to Thursday December 5th.

AI OnAI Off

Class PropertySettingsWrapper

Wrapper class that adds common properties like Id and DisplayName for IPropertySettings objects.

Inheritance
System.Object
PropertySettingsWrapper
CodeDefinedPropertySettingsWrapper
Namespace: EPiServer.Core.PropertySettings
Assembly: EPiServer.dll
Version: 12.0.3
Syntax
[EPiServerDataTable(TableName = "tblSystemBigTable")]
public class PropertySettingsWrapper : Object

Constructors

PropertySettingsWrapper()

Initializes a new instance of the PropertySettingsWrapper class.

Declaration
public PropertySettingsWrapper()

PropertySettingsWrapper(Guid, String, String, Boolean, Boolean, IPropertySettings)

Initializes a new instance of the PropertySettingsWrapper class.

Declaration
public PropertySettingsWrapper(Guid id, string displayName, string description, bool isDefault, bool isGlobal, IPropertySettings propertySettings)
Parameters
Type Name Description
System.Guid id

The id.
System.String displayName

The display name.
System.String description

The description.
System.Boolean isDefault

if set to true it is the default instance for the type.
System.Boolean isGlobal

if set to true it is a global instance available for all properties using this type.
IPropertySettings propertySettings

The property settings.

PropertySettingsWrapper(String, String, Boolean, Boolean, IPropertySettings)

Initializes a new instance of the PropertySettingsWrapper class.

Declaration
public PropertySettingsWrapper(string displayName, string description, bool isDefault, bool isGlobal, IPropertySettings propertySettings)
Parameters
Type Name Description
System.String displayName

The display name.
System.String description

The description.
System.Boolean isDefault

if set to true it is the default instance for the type.
System.Boolean isGlobal

if set to true it is a isGlobal instance available for all properties using this type.
IPropertySettings propertySettings

The property settings.

Properties

DefinedByCode

Indicates if this settings wrapper is defined by code or not.

Declaration
public bool DefinedByCode { get; }
Property Value
Type Description
System.Boolean

Description

Gets the description. Used in the admin UI to distinguish between global settings

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

The description.

DisplayName

Gets the display name. Used in the admin UI to distinguish between global settings

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

The display name.

Id

Gets or sets the id.

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

The id.

IsDefault

Gets or sets a value indicating whether this instance is the default setting for the instances System.Type.

Declaration
public bool IsDefault { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is default; otherwise, false.

IsGlobal

Gets or sets a value indicating whether this instance is a global setting for the instances System.Type.

Declaration
public bool IsGlobal { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is a global setting; otherwise, false.

PropertySettings

Gets or sets the actual property settings object.

Declaration
public virtual IPropertySettings PropertySettings { get; set; }
Property Value
Type Description
IPropertySettings

The property settings.

TypeFullName

Gets or sets the full name of the type for the actual settings.

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

The full name of the type of the actual settings.

Methods

Copy()

Copies this instance.

Declaration
public virtual PropertySettingsWrapper Copy()
Returns
Type Description
PropertySettingsWrapper

A deep copy of this instance.

Extension Methods