Class Settings

Namespace

FrameOfReference.Presentation.Config

Assembly

FrameOfReference.Presentation.dll

Stores settings for the application

public sealed class Settings : SettingsBase

Inheritance

object

SettingsBase

Settings

Inherited Members

SettingsBase.General

SettingsBase.Display

SettingsBase.Graphics

SettingsBase.Editor

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Extension Methods

XmlZipStorage.SaveXmlZip<T>(T, Stream, string?, params EmbeddedFile[])

XmlZipStorage.SaveXmlZip<T>(T, string, string?, params EmbeddedFile[])

Properties

Controls

Stores settings for the user controls (mouse, keyboard, etc.).

public ControlsSettings Controls { get; set; }

Property Value

ControlsSettings

Current

The currently active set of settings

public static Settings Current { get; }

Property Value

Settings

Methods

AddChangeHandler(Action)

Registers a handler to be invoked when any of the settings have been changed.

protected override void AddChangeHandler(Action handler)

Parameters

handler Action

Config()

Displays a configuration interface for the settings, allowing easy manipulation of values

public void Config()

EnableAutoSave()

Configures Current settings to be automatically saved when they are changed.

public static void EnableAutoSave()

LoadCurrent()

Loads the current settings from an automatically located XML file

[LuaGlobal(Name = "LoadSettings", Description = "Loads the current settings from an automatically located XML file")]
public static Settings LoadCurrent()

Returns

Settings

Remarks

Any errors are logged and then ignored.

SaveCurrent()

Saves the current settings to an automatically located XML file

[LuaGlobal(Name = "SaveSettings", Description = "Saves the current settings to an automatically located XML file")]
public static void SaveCurrent()

Remarks

Any errors are logged and then ignored.