Interface ISettingsManager

interface for Settings Manager

Namespace: Phoenix.Settings

Assembly: Phoenix.Abstractions.Settings.dll

Syntax

public interface ISettingsManager

Properties

AppDataDirectoryRoot

Gets the root folder for the settings files.

Declaration

string AppDataDirectoryRoot { get; }

Property Value

Type	Description
System.String

SettingsCategories

Gets an enumeration of the settings categories.

Declaration

IEnumerable<SettingsCategoryBase> SettingsCategories { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<SettingsCategoryBase>

Methods

ChangeSettings(SettingChangeInfo)

Changes the values for the specified settings, and publishes a SettingsChangeEvent.

Declaration

void ChangeSettings(SettingChangeInfo changeInfo)

Parameters

Type	Name	Description
SettingChangeInfo	changeInfo	The setting being changed.

ChangeSettings(List<SettingChangeInfo>)

Bulk version of the ChangeSetting function

Declaration

void ChangeSettings(List<SettingChangeInfo> changeInfos)

Parameters

Type	Name	Description
System.Collections.Generic.List<SettingChangeInfo>	changeInfos	List of settings to change.

LoadSettings<T>()

Loads in the specified settings from an xml file.

Declaration

T LoadSettings<T>()
    where T : SettingsCategoryBase

Returns

Type	Description
T	The settings object, populated with either default values (file not found) or loaded values from file.

Type Parameters

Name	Description
T	Type of the object

LoadSettings<T>(String)

Loads in the specified settings from an xml file.

Declaration

T LoadSettings<T>(string settingsName)
    where T : SettingsCategoryBase

Parameters

Type	Name	Description
System.String	settingsName	The name of the settings to load from (null will use default).

Returns

Type	Description
T	The settings object, populated with either default values (file not found) or loaded values from file.

Type Parameters

Name	Description
T	Type of the object