Settings Class

Namespace: XmlNotepad

Settings is a container for persistent settings that you want to store in a file like XmlNotepad.settings.

C++

Visual Basic

IDL

JavaScript

class Settings : public IDisposable;

Inheritance

System.IDisposable XmlNotepad.Settings

Constructors

Settings

Note this is an IDisposable object, so remember to call Dispose() on it during application shutdown.

Events

Changed

This event is raised when a particular setting has been changed. A special setting named "File" is... more

Methods

Show:Protected

No members matching the current filter

Dispose()	This is Dispose, a member of class Settings.
Dispose(bool)	This is Dispose, a member of class Settings.
Load	Loads the specified settings file and deserializes values. It uses the existing settings to figure out the type to convert... more
OnChanged	Call this method if you know a particular setting object has changed. This raises the Changed event. This will happen... more
Reload	Reloads the settings from the current file on disk.
Save	Serializes property values to the settings file.
StopWatchingFileChanges	This method is usually called right before you update the settings and save them to disk.

Properties

FileName

This is FileName, a member of class Settings.

Indexers

this	Get or set a named setting passing the typed object to be serialized.

Remarks

Each setting has a name and some typed value. The deserialization process returns strings by default. If you want a typed value returned then you need to initialize the settings class with a default typed value so it can figure out what type to return. The type information is not stored in the settings file. Any type that has a corresponding TypeConverter is supported as well as Hashtable, Array and any IXmlSerializable object. This class also provides some useful features that most people expect to get out of their settings files, namely:

Watching changes on disk and automatically reloading the file, then generating an event so that the hosting application can react to those changes.
Transform any Uri setting to a persistent file name using the PersistentFileNames class.