All types|All members

Legend

Class
Struct
Enum
Interface
Delegate
Constructor
Method
Property
Event
Field

Abstract class: RT.Util.SettingsThreadedBase

Summary

Like SettingsBase, but implements an additional save method.

Instance methods

void
Delete(string filename = null, SettingsOnFailure onFailure = SettingsOnFailure.Throw)
Deletes the settings file.
void
Save(string filename = null, SettingsSerializer? serializer = null, SettingsOnFailure onFailure = SettingsOnFailure.Throw)

Saves the settings.

This method is fully compatible with SettingsThreadedBase.SaveThreaded(string, SettingsSerializer?), and will cancel any pending earlier (older) saves.

void
SaveLoud(string filename = null, SettingsSerializer? serializer = null)

Saves the settings. Intended to be used whenever the settings are important enough to bug the user if this fails.

This method is fully compatible with SettingsThreadedBase.SaveThreaded(string, SettingsSerializer?), and will cancel any pending earlier (older) saves.

void
SaveQuiet(string filename = null, SettingsSerializer? serializer = null)

Saves the settings. Intended to be used whenever the settings are not important enough to bug the user if this fails.

This method is fully compatible with SettingsThreadedBase.SaveThreaded(string, SettingsSerializer?), and will cancel any pending earlier (older) saves.

void
SaveThreaded(string filename = null, SettingsSerializer? serializer = null)
  • Virtual

Saves the settings. Intended for frequent use at any point where it would make sense to commit settings, but would not make sense to bug the user about any failures. This method is like SettingsBase.SaveQuiet(string, SettingsSerializer?), except that the actual save occurs slightly later on a separate thread. The method returns as soon as SettingsThreadedBase.CloneForSaveThreaded() returns.

Note that this method is NOT guaranteed to save settings, but it usually will. Make sure you call SettingsBase.Save(string, SettingsSerializer?, SettingsOnFailure) when you want to guarantee a save, especially just before the program terminates.

Instance properties

SettingsAttribute
Attribute
 Gets the SettingsAttribute instance specified on this settings class, or null if none are specified.