PersistentSettings

PersistentSettings class

A dictionary of SettingValue items.

Derived Classes:

Namespace: Rhino
PersistentSettings: references

Constructors (1)

PersistentSettings(SerializationInfo info, StreamingContext context)

Properties (5)

ChildKeys

Gets a collection containing the keys in the settings dictionary.

HiddenFromUserInterface

If False then values will appear in the EditOptions window

Keys

Gets a collection containing the keys in the settings dictionary.

RhinoAppSettings

StringListRootKey

Adding this string to a string list when calling SetStringList will cause the ProgramData setting to get inserted at that location in the list.

Methods (157)

AddChild(string key)

Call this method to add a new child key, if the key is exists then the existing key is returned otherwise a new empty PersistentSettings child key is added and the new settings are returned.

ClearChangedFlag()

ContainsChangedValues()

ContainsModifiedValues(PersistentSettings allUserSettings)

DeleteChild(string key)

Call this method to delete a child settings key.

DeleteItem(string key)

FromPlugInId(Guid pluginId)

GetBool(string key, bool defaultValue, IEnumerable<string> legacyKeyList)

GetBool(string key, bool defaultValue)

GetBool(string key)

GetByte(string key, byte defaultValue, IEnumerable<string> legacyKeyList)

GetByte(string key, byte defaultValue)

GetByte(string key)

GetChar(string key, char defaultValue, IEnumerable<string> legacyKeyList)

GetChar(string key, char defaultValue)

GetChar(string key)

GetChild(string key)

Call this method to get a nested settings PersistentSettings instance, will throw a KeyNotFoundException exception if the key does not exist.

GetColor(string key, Color defaultValue, IEnumerable<string> legacyKeyList)

GetColor(string key, Color defaultValue)

GetColor(string key, Color? defaultValue, IEnumerable<string> legacyKeyList)

GetColor(string key, Color? defaultValue)

GetColor(string key)

GetDate(string key,DateTime defaultValue, IEnumerable<string> legacyKeyList)

GetDate(string key,DateTime defaultValue)

GetDate(string key)

GetDouble(string key, double defaultValue, IEnumerable<string> legacyKeyList)

GetDouble(string key, double defaultValue)

GetDouble(string key)

GetEnumValue(String key, T defaultValue)

Gets a stored enumerated value using a custom key, or return default value if not found.

GetEnumValue(String key)

Get a stored enumerated value using a custom key.

GetEnumValue(T defaultValue)

Get a stored enumerated value, or return default value if not found

GetGuid(string key,Guid defaultValue, IEnumerable<string> legacyKeyList)

GetGuid(string key,Guid defaultValue)

GetGuid(string key)

GetInteger(string key, int defaultValue, IEnumerable<string> legacyKeyList)

GetInteger(string key, int defaultValue, int bound, bool boundIsLower)

GetInteger(string key, int defaultValue, int lowerBound, int upperBound)

GetInteger(string key, int defaultValue)

GetInteger(string key)

GetPoint(string key,Point defaultValue, IEnumerable<string> legacyKeyList)

GetPoint(string key,Point defaultValue)

GetPoint(string key)

GetPoint3d(string key, Point3d defaultValue, IEnumerable<string> legacyKeyList)

GetPoint3d(string key, Point3d defaultValue)

GetPoint3d(string key)

GetRectangle(string key, Rectangle defaultValue, IEnumerable<string> legacyKeyList)

GetRectangle(string key, Rectangle defaultValue)

GetRectangle(string key)

GetSettingIsHiddenFromUserInterface(string key, IEnumerable<string> legacyKeyList)

Values read from all users settings files will be marked as read-only which will cause any future calls to Set... to fail.

GetSettingIsHiddenFromUserInterface(string key)

Values read from all users settings files will be marked as read-only which will cause any future calls to Set... to fail.

GetSettingIsReadOnly(string key)

Values read from all users settings files will be marked as read-only which will cause any future calls to Set... to fail.

GetSettingType(string key)

Gets the type of the last value passed to Set... or Get... for the specified setting.

GetSize(string key, Size defaultValue, IEnumerable<string> legacyKeyList)

GetSize(string key, Size defaultValue)

GetSize(string key)

GetString(string key, string defaultValue, IEnumerable<string> legacyKeyList)

GetString(string key, string defaultValue)

GetString(string key)

GetStringDictionary(string key, KeyValuePair<string, string>[] defaultValue, IEnumerable<string> legacyKeyList)

GetStringDictionary(string key, KeyValuePair<string, string>[] defaultValue)

GetStringDictionary(string key)

GetStringList(string key, string defaultValue, IEnumerable<string> legacyKeyList)

GetStringList(string key, string defaultValue)

GetStringList(string key)

GetUnsignedInteger(string key, uint defaultValue, IEnumerable<string> legacyKeyList)

GetUnsignedInteger(string key, uint defaultValue)

GetUnsignedInteger(string key)

GetValidator(string key)

Provides a way to find a ready-to-use validator for the PersistentSetting class for the given the key, or obtaining null.

HideSettingFromUserInterface(string key)

RegisterSettingsValidator(string key, EventHandler<PersistentSettingsEventArgs<T>> validator)

Sets a validator for a given key.
Note to implementers: parameter T should be one of the supported types for the PersistentSettings class and should match the type associated with the key.
This method allows to use anonymous methods and lambda expressions.

SetBool(string key, bool value)

SetByte(string key, byte value)

SetChar(string key, char value)

SetColor(string key, Color value)

SetColor(string key, Color? value)

SetDate(string key,DateTime value)

SetDefault(string key, bool value)

SetDefault(string key, byte value)

SetDefault(string key, char value)

SetDefault(string key, Color value)

SetDefault(string key, Color? value)

SetDefault(string key, double value)

SetDefault(string key, int value)

SetDefault(string key, KeyValuePair<string, string>[] value)

SetDefault(string key, Point3d value)

SetDefault(string key, Rectangle value)

SetDefault(string key, Size value)

SetDefault(string key, string value)

SetDefault(string key,DateTime value)

SetDefault(string key,Point value)

SetDefault(string key,Guid value)

SetDouble(string key, double value)

SetEnumValue(String key, T value)

Set an enumerated value in the settings using a custom key

SetEnumValue(T enumValue)

Set an enumerated value in the settings.

SetGuid(string key,Guid value)

SetInteger(string key, int value)

SetPoint(string key,Point value)

SetPoint3d(string key, Point3d value)

SetRectangle(string key, Rectangle value)

SetSize(string key, Size value)

SetString(string key, string value)

SetStringDictionary(string key, KeyValuePair<string, string>[] value)

SetStringList(string key, string value)

Including a item with the value of StringListRootKey will cause the ProgramData value to get inserted at that location in the list when calling GetStringList.

SetUnsignedInteger(string key, uint value)

TryGetBool(string key, out bool value, IEnumerable<string> legacyKeyList)

TryGetBool(string key, out bool value)

TryGetByte(string key, out byte value, IEnumerable<string> legacyKeyList)

TryGetByte(string key, out byte value)

TryGetChar(string key, out char value, IEnumerable<string> legacyKeyList)

TryGetChar(string key, out char value)

TryGetChild(string key, out PersistentSettings value)

Call this method to get a nested settings PersistentSettings instance, will return True if the key exists and value was set otherwise; will return False and value will be set to null.

TryGetColor(string key, out Color value, IEnumerable<string> legacyKeyList)

TryGetColor(string key, out Color value)

TryGetColor(string key, out Color? value, IEnumerable<string> legacyKeyList)

TryGetColor(string key, out Color? value)

TryGetDate(string key,DateTime value, IEnumerable<string> legacyKeyList)

TryGetDate(string key,DateTime value)

TryGetDefault(string key, out bool value)

TryGetDefault(string key, out byte value)

TryGetDefault(string key, out char value)

TryGetDefault(string key, out Color value)

TryGetDefault(string key, out double value)

TryGetDefault(string key, out int value)

TryGetDefault(string key, out Point3d value)

TryGetDefault(string key, out Rectangle value)

TryGetDefault(string key, out Size value)

TryGetDefault(string key, out string value)

TryGetDefault(string key,DateTime value)

TryGetDouble(string key, out double value, IEnumerable<string> legacyKeyList)

TryGetDouble(string key, out double value)

TryGetEnumValue(String key, out T enumValue)

Attempt to get the stored value for an enumerated setting using a custom key. Note: the enumerated value ALWAYS gets assigned! Be sure to check for success of this method to prevent erroneous use of the value.

TryGetGuid(string key,Guid value, IEnumerable<string> legacyKeyList)

TryGetGuid(string key,Guid value)

TryGetInteger(string key, out int value, IEnumerable<string> legacyKeyList)

TryGetInteger(string key, out int value)

TryGetPoint(string key,Point value, IEnumerable<string> legacyKeyList)

TryGetPoint(string key,Point value)

TryGetPoint3d(string key, out Point3d value, IEnumerable<string> legacyKeyList)

TryGetPoint3d(string key, out Point3d value)

TryGetRectangle(string key, out Rectangle value, IEnumerable<string> legacyKeyList)

TryGetRectangle(string key, out Rectangle value)

TryGetSettingIsHiddenFromUserInterface(string key, out bool value, IEnumerable<string> legacyKeyList)

Values read from all users settings files will be marked as read-only which will cause any future calls to Set... to fail.

TryGetSettingIsHiddenFromUserInterface(string key, out bool value)

Values read from all users settings files will be marked as read-only which will cause any future calls to Set... to fail.

TryGetSettingIsReadOnly(string key, out bool value)

Values read from all users settings files will be marked as read-only which will cause any future calls to Set... to fail.

TryGetSettingType(string key,Type type)

Get the type of the last value passed to Set... or Get... for the specified setting.

TryGetSize(string key, out Size value, IEnumerable<string> legacyKeyList)

TryGetSize(string key, out Size value)

TryGetString(string key, out string value, IEnumerable<string> legacyKeyList)

TryGetString(string key, out string value)

TryGetStringDictionary(string key, out KeyValuePair<string, string>[] value, IEnumerable<string> legacyKeyList)

TryGetStringDictionary(string key, out KeyValuePair<string, string>[] value)

TryGetStringList(string key, out string value, IEnumerable<string> legacyKeyList)

TryGetStringList(string key, out string value)

TryGetUnsignedInteger(string key, out uint value, IEnumerable<string> legacyKeyList)

TryGetUnsignedInteger(string key, out uint value)

Nothing found