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

Class PropertySettingsRepository

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Acts as the link between the PropertySettingsContainer and data storage.

Inheritance
System.Object
PropertySettingsRepository
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.Internal
Assembly: EPiServer.dll
Version: 11.20.7
Syntax
[ServiceConfiguration(ServiceType = typeof(IPropertySettingsRepository), Lifecycle = ServiceInstanceScope.Singleton)]
public class PropertySettingsRepository : IPropertySettingsRepository

Constructors

PropertySettingsRepository()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Initializes a new instance of the PropertySettingsRepository class.

Declaration
public PropertySettingsRepository()

PropertySettingsRepository(IEnumerable<PropertySettings>, DynamicDataStoreFactory, ISynchronizedObjectInstanceCache)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Initializes a new instance of the PropertySettingsRepository class.

Declaration
public PropertySettingsRepository(IEnumerable<PropertySettings> settingsByCode, DynamicDataStoreFactory dynamicDataStoreFactory, ISynchronizedObjectInstanceCache iSynchronizedObjectInstanceCache)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<PropertySettings> settingsByCode
DynamicDataStoreFactory dynamicDataStoreFactory
ISynchronizedObjectInstanceCache iSynchronizedObjectInstanceCache

Methods

Delete(PropertySettingsContainer)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Deletes the specified PropertySettingsContainer.

Declaration
public void Delete(PropertySettingsContainer propertySetting)
Parameters
Type Name Description
PropertySettingsContainer propertySetting

The PropertySettingsContainer to delete.

Delete(Guid)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Deletes the specified PropertySettingsContainer.

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

The System.Guid of the PropertySettingsContainer to delete.

DeleteGlobal(Guid)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Deletes the specified PropertySettingsWrapper.

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

The id of the PropertySettingsWrapper to delete.

DeleteStore()

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. This member supports the EPiServer infrastructure and is not intended to be used directly from your code.

Declaration
public static void DeleteStore()

GetDefault(Type)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets the default PropertySettings.

Declaration
public PropertySettingsWrapper GetDefault(Type propertyType)
Parameters
Type Name Description
System.Type propertyType

Type of the property.

Returns
Type Description
PropertySettingsWrapper

true if successful.

GetGlobals(Type)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Gets a list of PropertySettings for a specified Type where IsGlobal is true.

Declaration
public IEnumerable<PropertySettingsWrapper> GetGlobals(Type propertyType)
Parameters
Type Name Description
System.Type propertyType

Type of the property.

Returns
Type Description
System.Collections.Generic.IEnumerable<PropertySettingsWrapper>

List of global settings for a type

OnPropertySettingSaved(PropertySettingsRepositoryEventArg)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Raises the PropertySettingSaved event.

Declaration
protected virtual void OnPropertySettingSaved(PropertySettingsRepositoryEventArg args)
Parameters
Type Name Description
PropertySettingsRepositoryEventArg args

The PropertySettingsRepositoryEventArg instance containing the event data.

Save(PropertySettingsContainer)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Saves the specified PropertySettingsContainer.

Declaration
public void Save(PropertySettingsContainer container)
Parameters
Type Name Description
PropertySettingsContainer container

The PropertySettingsContainer to save.

Save(PropertySettingsWrapper)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Saves the specified PropertySettingsWrapper.

Declaration
public void Save(PropertySettingsWrapper wrapper)
Parameters
Type Name Description
PropertySettingsWrapper wrapper

The PropertySettingsWrapper to save.

SaveGlobal(PropertySettingsWrapper)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Saves the global adding or replacing it in the globals collection.

Declaration
public void SaveGlobal(PropertySettingsWrapper global)
Parameters
Type Name Description
PropertySettingsWrapper global

The global settings instance to save.

SetDefault(Guid)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Sets which PropertySettings that is the default.

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

The id of the propertySetting.

TryGetContainer(Guid, out PropertySettingsContainer)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Tries to get a PropertySettingsContainer.

Declaration
public bool TryGetContainer(Guid id, out PropertySettingsContainer propertySettingsContainer)
Parameters
Type Name Description
System.Guid id

The id of the propertySettingsContainer.

PropertySettingsContainer propertySettingsContainer

The propertySetting to get.

Returns
Type Description
System.Boolean

true if successful.

TryGetWrapper(Guid, out PropertySettingsWrapper)

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Tries to get a PropertySettingsWrapper.

Declaration
public bool TryGetWrapper(Guid id, out PropertySettingsWrapper propertySettingsWrapper)
Parameters
Type Name Description
System.Guid id

The id of the PropertySettingsWrapper.

PropertySettingsWrapper propertySettingsWrapper

The PropertySettingsWrapper to get.

Returns
Type Description
System.Boolean

true if successful.

Events

PropertySettingSaved

Unsupported INTERNAL API! Not covered by semantic versioning; might change without notice. Occurs when a PropertySettingsContainer has been saved, i.e. created or updated.

Declaration
public static event EventHandler<PropertySettingsRepositoryEventArg> PropertySettingSaved
Event Type
Type Description
System.EventHandler<PropertySettingsRepositoryEventArg>

Implements

Extension Methods