Class PluginSettings

Container for storing and loading settings in XML format

Inheritance

System.Object

PluginSettings

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Phoenix.Input

Assembly: Phoenix.Plugin.Input.dll

Syntax

public class PluginSettings

Constructors

PluginSettings()

Initializes a new instance of the PluginSettings class

Declaration

public PluginSettings()

Properties

LastKeyboardPressEnter

Gets or sets a value indicating whether last setting for keyboard simulation was to press enter after input

Declaration

public bool LastKeyboardPressEnter { get; set; }

Property Value

Type	Description
System.Boolean

LastKeyboardPressTime

Gets or sets the last setting for button press time in keyboard simulation

Declaration

public double LastKeyboardPressTime { get; set; }

Property Value

Type	Description
System.Double

LastKeyboardWaitTime

Gets or sets the last setting for action wait time in keyboard simulation

Declaration

public double LastKeyboardWaitTime { get; set; }

Property Value

Type	Description
System.Double

Location

Gets the settings file full path

Declaration

public static string Location { get; }

Property Value

Type	Description
System.String

RecentFiles

Gets or sets the recent files

Declaration

public string RecentFiles { get; set; }

Property Value

Type	Description
System.String

ViewRatio

Gets or sets the view ratio for sequence control (pixels to seconds)

Declaration

public string ViewRatio { get; set; }

Property Value

Type	Description
System.String

Methods

Load()

Loads plugin settings

Declaration

public static PluginSettings Load()

Returns

Type	Description
PluginSettings	Settings loaded

LoadingFailed()

Gets a bool marking if an error occurred while attempting to load a settings file, and thus default settings were used instead.

Declaration

public bool LoadingFailed()

Returns

Type	Description
System.Boolean	true if an error occurred

Save()

Saves plug-in settings

Declaration

public void Save()