Client.LocalSettings Class Reference

Manages settings for the local program. Adding new settings are done by adding the property, adding it to the lists in the constructor and to SaveSettings() Defaults are set at the end of the constructor - the false section of the shorthand conditional statement TODO: Make a prettier way to define default settings! More...

List of all members.

Public Member Functions
	LocalSettings ()
	Constructor for the LocalSettings class. Takes care of loading settings.
Properties
string	Username [get, set]
	Gets and sets the username property.
string	Password [get, set]
	Gets and sets the password property.
bool	RememberMe [get, set]
	Gets and sets the rememberme property.
string	Server [get, set]
	Gets and sets the server name property.
int	Port [get, set]
	Gets and sets the server port property.
Private Member Functions
internal void	SaveSettings ()
	Saves the settings - called each time a setting is changed. This can be done because there are so few settings that the function is efficient enough that it will cause only very slight decrease of speed.
Private Attributes
string	username = ""
	A user's username, if they request their information be saved.
string	password = ""
	A user's paddword, if they request their information be saved.
bool	rememberme = false
	Wether to save the user's information with the client.
string	server = "localhost"
	The name part of the address to the server we are connecting to.
int	port = 8080
	The port of the server we are connecting to.
XmlWriterSettings	writerSettings
	The settings for our XmlWriter.
string	settingsFile
	Where are we saving the settings to? Set by the LocalSettings constructor.

---

Detailed Description

Manages settings for the local program. Adding new settings are done by adding the property, adding it to the lists in the constructor and to SaveSettings() Defaults are set at the end of the constructor - the false section of the shorthand conditional statement TODO: Make a prettier way to define default settings!

Definition at line 17 of file LocalSettings.cs.

---

Constructor & Destructor Documentation

Client.LocalSettings.LocalSettings

(

)

Constructor for the LocalSettings class. Takes care of loading settings.

Definition at line 38 of file LocalSettings.cs.

References Client.LocalSettings.password, Client.LocalSettings.port, Client.LocalSettings.rememberme, Client.LocalSettings.server, Client.LocalSettings.settingsFile, Client.LocalSettings.username, and Client.LocalSettings.writerSettings.

---

Member Function Documentation

internal void Client.LocalSettings.SaveSettings

(

)

[private]

Saves the settings - called each time a setting is changed. This can be done because there are so few settings that the function is efficient enough that it will cause only very slight decrease of speed.

Definition at line 114 of file LocalSettings.cs.

References Client.LocalSettings.password, Client.LocalSettings.port, Client.LocalSettings.rememberme, Client.LocalSettings.server, Client.LocalSettings.settingsFile, Client.LocalSettings.username, and Client.LocalSettings.writerSettings.

---

Member Data Documentation

string Client.LocalSettings.username = "" [private]

A user's username, if they request their information be saved.

Definition at line 20 of file LocalSettings.cs.

Referenced by Client.LocalSettings.LocalSettings(), and Client.LocalSettings.SaveSettings().

string Client.LocalSettings.password = "" [private]

A user's paddword, if they request their information be saved.

Definition at line 22 of file LocalSettings.cs.

Referenced by Client.LocalSettings.LocalSettings(), and Client.LocalSettings.SaveSettings().

bool Client.LocalSettings.rememberme = false [private]

Wether to save the user's information with the client.

Definition at line 24 of file LocalSettings.cs.

Referenced by Client.LocalSettings.LocalSettings(), and Client.LocalSettings.SaveSettings().

string Client.LocalSettings.server = "localhost" [private]

The name part of the address to the server we are connecting to.

Definition at line 26 of file LocalSettings.cs.

Referenced by Client.LocalSettings.LocalSettings(), and Client.LocalSettings.SaveSettings().

int Client.LocalSettings.port = 8080 [private]

The port of the server we are connecting to.

Definition at line 28 of file LocalSettings.cs.

Referenced by Client.LocalSettings.LocalSettings(), and Client.LocalSettings.SaveSettings().

XmlWriterSettings Client.LocalSettings.writerSettings [private]

The settings for our XmlWriter.

Definition at line 31 of file LocalSettings.cs.

Referenced by Client.LocalSettings.LocalSettings(), and Client.LocalSettings.SaveSettings().

string Client.LocalSettings.settingsFile [private]

Where are we saving the settings to? Set by the LocalSettings constructor.

Definition at line 33 of file LocalSettings.cs.

Referenced by Client.LocalSettings.LocalSettings(), and Client.LocalSettings.SaveSettings().

---

Property Documentation

string Client.LocalSettings.Username [get, set]

Gets and sets the username property.

Definition at line 76 of file LocalSettings.cs.

Referenced by Client.Login.btnLogin_Click(), Client.Login.cmdForgetMe_LinkClicked(), and Client.Login.Login().

string Client.LocalSettings.Password [get, set]

Gets and sets the password property.

Definition at line 83 of file LocalSettings.cs.

Referenced by Client.Login.btnLogin_Click(), Client.Login.cmdForgetMe_LinkClicked(), and Client.Login.Login().

bool Client.LocalSettings.RememberMe [get, set]

Gets and sets the rememberme property.

Definition at line 90 of file LocalSettings.cs.

string Client.LocalSettings.Server [get, set]

Gets and sets the server name property.

Definition at line 97 of file LocalSettings.cs.

Referenced by Client.LoginConfig.btnSave_Click(), Client.RMIClient.Connect(), and Client.LoginConfig.LoginConfig().

int Client.LocalSettings.Port [get, set]

Gets and sets the server port property.

Definition at line 104 of file LocalSettings.cs.

Referenced by Client.LoginConfig.btnSave_Click(), Client.RMIClient.Connect(), and Client.LoginConfig.LoginConfig().

---

The documentation for this class was generated from the following file:

• Client/LocalSettings.cs

---