Class PropertySettings
Used to define a specific set of settings for a property, for instance the tools that should be available for an html editor.
Namespace: EPiServer.Core.PropertySettings
Assembly: EPiServer.dll
Version: 12.0.3Syntax
public abstract class PropertySettings : ObjectConstructors
PropertySettings()
Declaration
protected PropertySettings()Properties
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 the identifier for this specific settings.
Declaration
public abstract Guid ID { get; }Property Value
| Type | Description |
|---|---|
| System.Guid | The identifier. |
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 |
|
Remarks
The order of importance used when a property setting is resolved is:
SettingsType
Gets the type of the settings.
Declaration
public abstract Type SettingsType { get; }Property Value
| Type | Description |
|---|---|
| System.Type | The type of the settings. |
Methods
GetPropertySettings()
Gets the property settings.
Declaration
public virtual IPropertySettings GetPropertySettings()Returns
| Type | Description |
|---|---|
| IPropertySettings | The property settings |
Remarks
This will be called each time an editor is instantiated which makes it possible to customize the return value, for instance for different roles.
GetSettingsInternal()
Used to actually return the settings object from a base class.
Declaration
protected abstract IPropertySettings GetSettingsInternal()Returns
| Type | Description |
|---|---|
| IPropertySettings | The actual settings object used for a property. |
