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!

Interface IPropertySettingsRepository

Acts as the link between the PropertySettingsContainer and data storage.

Namespace: EPiServer.Core.PropertySettings
Assembly: EPiServer.dll
Version: 11.20.7
Syntax
public interface IPropertySettingsRepository

Methods

Delete(PropertySettingsContainer)

Deletes the specified PropertySettingsContainer.

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

The PropertySettingsContainer to delete.

Delete(Guid)

Deletes the specified PropertySettingsContainer.

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

The System.Guid of the PropertySettingsContainer to delete.

DeleteGlobal(Guid)

Deletes the specified global PropertySettingsWrapper.

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

The id of the PropertySettingsWrapper to delete.

GetDefault(Type)

Gets the default PropertySettingsWrapper.

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

Type of the property.

Returns
Type Description
PropertySettingsWrapper

true if successful.

GetGlobals(Type)

Gets a list of PropertySettingsWrapper for a specified Type.

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

Type of the property setting.

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

List of global settings for a type

Save(PropertySettingsContainer)

Saves the specified PropertySettingsContainer.

Declaration
void Save(PropertySettingsContainer propertySetting)
Parameters
Type Name Description
PropertySettingsContainer propertySetting

The PropertySettingsContainer to save.

SaveGlobal(PropertySettingsWrapper)

Saves the global adding or replacing it in the globals collection.

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

The global settings instance to save.

SetDefault(Guid)

Sets which PropertySettingsWrapper that is the default.

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

The id of the propertySetting.

TryGetContainer(Guid, out PropertySettingsContainer)

Tries to get a PropertySettingsContainer.

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

The id of the propertySetting.

PropertySettingsContainer propertySettingsContainer

The propertySettingsContainer to get.

Returns
Type Description
System.Boolean

true if successful.

TryGetWrapper(Guid, out PropertySettingsWrapper)

Tries to get a PropertySettingsWrapper.

Declaration
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.

Extension Methods