PersistentSettings

References
[Serializable] public class PersistentSettings : ISerializable
A dictionary of SettingValue items.

Constructors

PersistentSettings

#
protected PersistentSettings(SerializationInfo info, StreamingContext context)
Parameters:
info (SerializationInfo)
context (StreamingContext)

Properties

ChildKeys

#Since v6.0
public ICollection<string> ChildKeys { get; }
Gets a collection containing the keys in the settings dictionary.

HiddenFromUserInterface

#Since v6.0
public bool HiddenFromUserInterface { get; set; }
If false then values will appear in the EditOptions window

Keys

#Since v6.0
public ICollection<string> Keys { get; }
Gets a collection containing the keys in the settings dictionary.

RhinoAppSettings

#Since v6.14
public static PersistentSettings RhinoAppSettings { get; }

StringListRootKey

#Since v5.0
public static string StringListRootKey { get; }
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

AddChild

#Since v6.0
public PersistentSettings 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.
Parameters:
key (string)Key to add to the child dictionary.
Returns: 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

#Since v6.0
public void ClearChangedFlag()

ContainsChangedValues

#Since v6.0
public bool ContainsChangedValues()

ContainsModifiedValues

#Since v5.0
public bool ContainsModifiedValues(PersistentSettings allUserSettings)
Parameters:
allUserSettings (PersistentSettings)

DeleteChild

#Since v6.0
public void DeleteChild(string key)
Call this method to delete a child settings key.
Parameters:
key (string)

DeleteItem

#Since v5.0
public void DeleteItem(string key)
Parameters:
key (string)

FromPlugInId

#Since v5.0
public static PersistentSettings FromPlugInId(Guid pluginId)
Parameters:
pluginId (Guid)

GetBool

#Since v6.0
public bool GetBool(string key, bool defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (bool)
legacyKeyList (IEnumerable<string>)

GetBool

#Since v5.0
public bool GetBool(string key, bool defaultValue)
Parameters:
key (string)
defaultValue (bool)

GetBool

#Since v5.0
public bool GetBool(string key)
Parameters:
key (string)

GetByte

#Since v6.0
public byte GetByte(string key, byte defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (byte)
legacyKeyList (IEnumerable<string>)

GetByte

#Since v5.0
public byte GetByte(string key, byte defaultValue)
Parameters:
key (string)
defaultValue (byte)

GetByte

#Since v5.0
public byte GetByte(string key)
Parameters:
key (string)

GetChar

#Since v6.0
public char GetChar(string key, char defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (char)
legacyKeyList (IEnumerable<string>)

GetChar

#Since v5.0
public char GetChar(string key, char defaultValue)
Parameters:
key (string)
defaultValue (char)

GetChar

#Since v5.0
public char GetChar(string key)
Parameters:
key (string)

GetChild

#Since v6.0
public PersistentSettings GetChild(string key)
Call this method to get a nested settings PersistentSettings instance, will throw a KeyNotFoundException exception if the key does not exist.
Parameters:
key (string)Key name
Returns: Returns persistent settings for the specified key or throws an exception if the key is invalid.
Exceptions:
KeyNotFoundExceptionThrown if the key does not exist.

GetColor

#Since v6.0
public Color GetColor(string key, Color defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (Color)
legacyKeyList (IEnumerable<string>)

GetColor

#Since v5.0
public Color GetColor(string key, Color defaultValue)
Parameters:
key (string)
defaultValue (Color)

GetColor

#Since v5.0
public Color GetColor(string key)
Parameters:
key (string)

GetColor

#
public Color? GetColor(string key, Color? defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (Color?)
legacyKeyList (IEnumerable<string>)

GetColor

#
public Color? GetColor(string key, Color? defaultValue)
Parameters:
key (string)
defaultValue (Color?)

GetDate

#Since v6.0
public DateTime GetDate(string key, DateTime defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (DateTime)
legacyKeyList (IEnumerable<string>)

GetDate

#Since v5.0
public DateTime GetDate(string key, DateTime defaultValue)
Parameters:
key (string)
defaultValue (DateTime)

GetDate

#Since v5.0
public DateTime GetDate(string key)
Parameters:
key (string)

GetDouble

#Since v6.0
public double GetDouble(string key, double defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (double)
legacyKeyList (IEnumerable<string>)

GetDouble

#Since v5.0
public double GetDouble(string key, double defaultValue)
Parameters:
key (string)
defaultValue (double)

GetDouble

#Since v5.0
public double GetDouble(string key)
Parameters:
key (string)

GetEnumValue<T>

#Since v5.4
[CLSCompliant(false)] public T GetEnumValue<T>(string key, T defaultValue)
Gets a stored enumerated value using a custom key, or return default value if not found.
Parameters:
key (string)
defaultValue (T)

GetEnumValue<T>

#Since v5.4
[CLSCompliant(false)] public T GetEnumValue<T>(string key)
Get a stored enumerated value using a custom key.
Parameters:
key (string)
Exceptions:
KeyNotFoundException

GetEnumValue<T>

#Since v5.4
[CLSCompliant(false)] public T GetEnumValue<T>(T defaultValue)
Get a stored enumerated value, or return default value if not found
Parameters:
defaultValue (T)

GetGuid

#Since v6.0
public Guid GetGuid(string key, Guid defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (Guid)
legacyKeyList (IEnumerable<string>)

GetGuid

#Since v6.0
public Guid GetGuid(string key, Guid defaultValue)
Parameters:
key (string)
defaultValue (Guid)

GetGuid

#Since v6.0
public Guid GetGuid(string key)
Parameters:
key (string)

GetInteger

#Since v6.0
public int GetInteger(string key, int defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (int)
legacyKeyList (IEnumerable<string>)

GetInteger

#Since v6.0
public int GetInteger(string key, int defaultValue, int bound, bool boundIsLower)
Parameters:
key (string)
defaultValue (int)
bound (int)
boundIsLower (bool)

GetInteger

#Since v6.0
public int GetInteger(string key, int defaultValue, int lowerBound, int upperBound)
Parameters:
key (string)
defaultValue (int)
lowerBound (int)
upperBound (int)

GetInteger

#Since v5.0
public int GetInteger(string key, int defaultValue)
Parameters:
key (string)
defaultValue (int)

GetInteger

#Since v5.0
public int GetInteger(string key)
Parameters:
key (string)

GetPoint

#Since v6.0
public Point GetPoint(string key, Point defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (Point)
legacyKeyList (IEnumerable<string>)

GetPoint

#Since v5.0
public Point GetPoint(string key, Point defaultValue)
Parameters:
key (string)
defaultValue (Point)

GetPoint

#Since v5.0
public Point GetPoint(string key)
Parameters:
key (string)

GetPoint3d

#Since v6.0
public Point3d GetPoint3d(string key, Point3d defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (Point3d)
legacyKeyList (IEnumerable<string>)

GetPoint3d

#Since v5.0
public Point3d GetPoint3d(string key, Point3d defaultValue)
Parameters:
key (string)
defaultValue (Point3d)

GetPoint3d

#Since v5.0
public Point3d GetPoint3d(string key)
Parameters:
key (string)

GetRectangle

#Since v6.0
public Rectangle GetRectangle(string key, Rectangle defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (Rectangle)
legacyKeyList (IEnumerable<string>)

GetRectangle

#Since v5.0
public Rectangle GetRectangle(string key, Rectangle defaultValue)
Parameters:
key (string)
defaultValue (Rectangle)

GetRectangle

#Since v5.0
public Rectangle GetRectangle(string key)
Parameters:
key (string)

GetSettingIsHiddenFromUserInterface

#Since v6.0
public bool 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.
Parameters:
key (string)Key name for which to search.
legacyKeyList (IEnumerable<string>)
Returns: Returns true if the setting is read-only otherwise false.
Exceptions:
KeyNotFoundExceptionA KeyNotFoundException exception is thrown if the key is not found in the settings dictionary.

GetSettingIsHiddenFromUserInterface

#Since v6.0
public bool 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.
Parameters:
key (string)Key name for which to search.
Returns: Returns true if the setting is read-only otherwise false.
Exceptions:
KeyNotFoundExceptionA KeyNotFoundException exception is thrown if the key is not found in the settings dictionary.

GetSettingIsReadOnly

#Since v6.0
public bool 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.
Parameters:
key (string)Key name for which to search.
Returns: Returns true if the setting is read-only otherwise false.
Exceptions:
KeyNotFoundExceptionA KeyNotFoundException exception is thrown if the key is not found in the settings dictionary.

GetSettingType

#Since v6.0
public Type GetSettingType(string key)
Gets the type of the last value passed to Set... or Get... for the specified setting.
Parameters:
key (string)Key name for which to search.
Returns: Type of the last value passed to Set... or Get... for the specified setting.
Exceptions:
KeyNotFoundExceptionA KeyNotFoundException exception is thrown if the key is not found in the settings dictionary.

GetSize

#Since v6.0
public Size GetSize(string key, Size defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (Size)
legacyKeyList (IEnumerable<string>)

GetSize

#Since v5.0
public Size GetSize(string key, Size defaultValue)
Parameters:
key (string)
defaultValue (Size)

GetSize

#Since v5.0
public Size GetSize(string key)
Parameters:
key (string)

GetString

#Since v6.0
public string GetString(string key, string defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (string)
legacyKeyList (IEnumerable<string>)

GetString

#Since v5.0
public string GetString(string key, string defaultValue)
Parameters:
key (string)
defaultValue (string)

GetString

#Since v5.0
public string GetString(string key)
Parameters:
key (string)

GetStringDictionary

#
public KeyValuePair<string, string>[] GetStringDictionary(string key, KeyValuePair<string, string>[] defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (KeyValuePair<string, string>[])
legacyKeyList (IEnumerable<string>)

GetStringDictionary

#
public KeyValuePair<string, string>[] GetStringDictionary(string key, KeyValuePair<string, string>[] defaultValue)
Parameters:
key (string)
defaultValue (KeyValuePair<string, string>[])

GetStringDictionary

#Since v6.0
public KeyValuePair<string, string>[] GetStringDictionary(string key)
Parameters:
key (string)

GetStringList

#Since v6.0
public string[] GetStringList(string key, string[] defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (string[])
legacyKeyList (IEnumerable<string>)

GetStringList

#Since v5.0
public string[] GetStringList(string key, string[] defaultValue)
Parameters:
key (string)
defaultValue (string[])

GetStringList

#Since v5.0
public string[] GetStringList(string key)
Parameters:
key (string)

GetUnsignedInteger

#Since v6.0
[CLSCompliant(false)] public uint GetUnsignedInteger(string key, uint defaultValue, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
defaultValue (uint)
legacyKeyList (IEnumerable<string>)

GetUnsignedInteger

#Since v5.0
[CLSCompliant(false)] public uint GetUnsignedInteger(string key, uint defaultValue)
Parameters:
key (string)
defaultValue (uint)

GetUnsignedInteger

#Since v5.0
[CLSCompliant(false)] public uint GetUnsignedInteger(string key)
Parameters:
key (string)

GetValidator<T>

#Since v5.0
public EventHandler<PersistentSettingsEventArgs<T>> GetValidator<T>(string key)
Provides a way to find a ready-to-use validator for the PersistentSetting class for the given the key, or obtaining null.
Parameters:
key (string)The name of the setting key.
Returns: A valid validator, or null if no validator was found.
Exceptions:
InvalidCastExceptionIf type parameter T is not the right specialization for PersistentSettingsEventArgs<T>.

HideSettingFromUserInterface

#Since v6.0
public void HideSettingFromUserInterface(string key)
Parameters:
key (string)

RegisterSettingsValidator<T>

#
public void RegisterSettingsValidator<T>(string key, EventHandler<PersistentSettingsEventArgs<T>> validator)
Sets a validator for a given key.

Note to implementers: 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.

Parameters:
key (string)The key to which to bind the validator.
validator (EventHandler<PersistentSettingsEventArgs<T>>)A validator instance of your own class.

SetBool

#Since v5.0
public void SetBool(string key, bool value)
Parameters:
key (string)
value (bool)

SetByte

#Since v5.0
public void SetByte(string key, byte value)
Parameters:
key (string)
value (byte)

SetChar

#Since v5.0
public void SetChar(string key, char value)
Parameters:
key (string)
value (char)

SetColor

#Since v5.0
public void SetColor(string key, Color value)
Parameters:
key (string)
value (Color)

SetColor

#
public void SetColor(string key, Color? value)
Parameters:
key (string)
value (Color?)

SetDate

#Since v5.0
public void SetDate(string key, DateTime value)
Parameters:
key (string)
value (DateTime)

SetDefault

#Since v5.0
public void SetDefault(string key, bool value)
Parameters:
key (string)
value (bool)

SetDefault

#Since v5.0
public void SetDefault(string key, byte value)
Parameters:
key (string)
value (byte)

SetDefault

#Since v5.0
public void SetDefault(string key, char value)
Parameters:
key (string)
value (char)

SetDefault

#Since v5.0
public void SetDefault(string key, Color value)
Parameters:
key (string)
value (Color)

SetDefault

#
public void SetDefault(string key, Color? value)
Parameters:
key (string)
value (Color?)

SetDefault

#Since v5.0
public void SetDefault(string key, DateTime value)
Parameters:
key (string)
value (DateTime)

SetDefault

#Since v5.0
public void SetDefault(string key, double value)
Parameters:
key (string)
value (double)

SetDefault

#Since v6.0
public void SetDefault(string key, Guid value)
Parameters:
key (string)
value (Guid)

SetDefault

#Since v5.0
public void SetDefault(string key, int value)
Parameters:
key (string)
value (int)

SetDefault

#
public void SetDefault(string key, KeyValuePair<string, string>[] value)
Parameters:
key (string)
value (KeyValuePair<string, string>[])

SetDefault

#Since v5.0
public void SetDefault(string key, Point value)
Parameters:
key (string)
value (Point)

SetDefault

#Since v5.0
public void SetDefault(string key, Point3d value)
Parameters:
key (string)
value (Point3d)

SetDefault

#Since v5.0
public void SetDefault(string key, Rectangle value)
Parameters:
key (string)
value (Rectangle)

SetDefault

#Since v5.0
public void SetDefault(string key, Size value)
Parameters:
key (string)
value (Size)

SetDefault

#Since v5.0
public void SetDefault(string key, string value)
Parameters:
key (string)
value (string)

SetDefault

#Since v5.0
public void SetDefault(string key, string[] value)
Parameters:
key (string)
value (string[])

SetDouble

#Since v5.0
public void SetDouble(string key, double value)
Parameters:
key (string)
value (double)

SetEnumValue<T>

#Since v5.4
[CLSCompliant(false)] public void SetEnumValue<T>(string key, T value)
Set an enumerated value in the settings using a custom key
Parameters:
key (string)
value (T)

SetEnumValue<T>

#Since v5.4
[CLSCompliant(false)] public void SetEnumValue<T>(T enumValue)
Set an enumerated value in the settings.
Parameters:
enumValue (T)

SetGuid

#Since v6.0
public void SetGuid(string key, Guid value)
Parameters:
key (string)
value (Guid)

SetInteger

#Since v5.0
public void SetInteger(string key, int value)
Parameters:
key (string)
value (int)

SetPoint

#Since v5.0
public void SetPoint(string key, Point value)
Parameters:
key (string)
value (Point)

SetPoint3d

#Since v5.0
public void SetPoint3d(string key, Point3d value)
Parameters:
key (string)
value (Point3d)

SetRectangle

#Since v5.0
public void SetRectangle(string key, Rectangle value)
Parameters:
key (string)
value (Rectangle)

SetSize

#Since v5.0
public void SetSize(string key, Size value)
Parameters:
key (string)
value (Size)

SetString

#Since v5.0
public void SetString(string key, string value)
Parameters:
key (string)
value (string)

SetStringDictionary

#
public void SetStringDictionary(string key, KeyValuePair<string, string>[] value)
Parameters:
key (string)
value (KeyValuePair<string, string>[])

SetStringList

#Since v5.0
public void 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.
Parameters:
key (string)The string key.
value (string[])An array of values to set.

SetUnsignedInteger

#Since v5.0
[CLSCompliant(false)] public void SetUnsignedInteger(string key, uint value)
Parameters:
key (string)
value (uint)
Explicit

ISerializable.GetObjectData

#
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)] void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
Parameters:
info (SerializationInfo)
context (StreamingContext)

TryGetBool

#Since v6.0
public bool TryGetBool(string key, out bool value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out bool)
legacyKeyList (IEnumerable<string>)

TryGetBool

#Since v5.0
public bool TryGetBool(string key, out bool value)
Parameters:
key (string)
value (out bool)

TryGetByte

#Since v6.0
public bool TryGetByte(string key, out byte value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out byte)
legacyKeyList (IEnumerable<string>)

TryGetByte

#Since v5.0
public bool TryGetByte(string key, out byte value)
Parameters:
key (string)
value (out byte)

TryGetChar

#Since v6.0
public bool TryGetChar(string key, out char value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out char)
legacyKeyList (IEnumerable<string>)

TryGetChar

#Since v5.0
public bool TryGetChar(string key, out char value)
Parameters:
key (string)
value (out char)

TryGetChild

#Since v6.0
public bool 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.
Parameters:
key (string)[in] Key name
value (out PersistentSettings)[out] Will be set the child settings if the key is valid otherwise it will be null.
Returns: Returns true if the key exists and value was set otherwise; returns false.

TryGetColor

#Since v6.0
public bool TryGetColor(string key, out Color value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out Color)
legacyKeyList (IEnumerable<string>)

TryGetColor

#Since v5.0
public bool TryGetColor(string key, out Color value)
Parameters:
key (string)
value (out Color)

TryGetColor

#
public bool TryGetColor(string key, out Color? value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out Color?)
legacyKeyList (IEnumerable<string>)

TryGetColor

#
public bool TryGetColor(string key, out Color? value)
Parameters:
key (string)
value (out Color?)

TryGetDate

#Since v6.0
public bool TryGetDate(string key, out DateTime value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out DateTime)
legacyKeyList (IEnumerable<string>)

TryGetDate

#Since v5.0
public bool TryGetDate(string key, out DateTime value)
Parameters:
key (string)
value (out DateTime)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out bool value)
Parameters:
key (string)
value (out bool)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out byte value)
Parameters:
key (string)
value (out byte)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out char value)
Parameters:
key (string)
value (out char)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out Color value)
Parameters:
key (string)
value (out Color)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out DateTime value)
Parameters:
key (string)
value (out DateTime)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out double value)
Parameters:
key (string)
value (out double)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out int value)
Parameters:
key (string)
value (out int)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out Point3d value)
Parameters:
key (string)
value (out Point3d)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out Rectangle value)
Parameters:
key (string)
value (out Rectangle)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out Size value)
Parameters:
key (string)
value (out Size)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out string value)
Parameters:
key (string)
value (out string)

TryGetDefault

#Since v5.0
public bool TryGetDefault(string key, out string[] value)
Parameters:
key (string)
value (out string[])

TryGetDouble

#Since v6.0
public bool TryGetDouble(string key, out double value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out double)
legacyKeyList (IEnumerable<string>)

TryGetDouble

#Since v5.0
public bool TryGetDouble(string key, out double value)
Parameters:
key (string)
value (out double)

TryGetEnumValue<T>

#Since v5.4
[CLSCompliant(false)] public bool TryGetEnumValue<T>(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.
Parameters:
key (string)
enumValue (out T)
Returns: true if successful

TryGetGuid

#Since v6.0
public bool TryGetGuid(string key, out Guid value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out Guid)
legacyKeyList (IEnumerable<string>)

TryGetGuid

#Since v6.0
public bool TryGetGuid(string key, out Guid value)
Parameters:
key (string)
value (out Guid)

TryGetInteger

#Since v6.0
public bool TryGetInteger(string key, out int value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out int)
legacyKeyList (IEnumerable<string>)

TryGetInteger

#Since v5.0
public bool TryGetInteger(string key, out int value)
Parameters:
key (string)
value (out int)

TryGetPoint

#Since v6.0
public bool TryGetPoint(string key, out Point value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out Point)
legacyKeyList (IEnumerable<string>)

TryGetPoint

#Since v5.0
public bool TryGetPoint(string key, out Point value)
Parameters:
key (string)
value (out Point)

TryGetPoint3d

#Since v6.0
public bool TryGetPoint3d(string key, out Point3d value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out Point3d)
legacyKeyList (IEnumerable<string>)

TryGetPoint3d

#Since v5.0
public bool TryGetPoint3d(string key, out Point3d value)
Parameters:
key (string)
value (out Point3d)

TryGetRectangle

#Since v6.0
public bool TryGetRectangle(string key, out Rectangle value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out Rectangle)
legacyKeyList (IEnumerable<string>)

TryGetRectangle

#Since v5.0
public bool TryGetRectangle(string key, out Rectangle value)
Parameters:
key (string)
value (out Rectangle)

TryGetSettingIsHiddenFromUserInterface

#Since v6.0
public bool 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.
Parameters:
key (string)Key name for which to search.
value (out bool)Value will be true if the setting is read-only otherwise false. setting.
legacyKeyList (IEnumerable<string>)

TryGetSettingIsHiddenFromUserInterface

#Since v6.0
public bool 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.
Parameters:
key (string)Key name for which to search.
value (out bool)Value will be true if the setting is read-only otherwise false. setting.

TryGetSettingIsReadOnly

#Since v6.0
public bool 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.
Parameters:
key (string)Key name for which to search.
value (out bool)Value will be true if the setting is read-only otherwise false. setting.

TryGetSettingType

#Since v6.0
public bool TryGetSettingType(string key, out Type type)
Get the type of the last value passed to Set... or Get... for the specified setting.
Parameters:
key (string)Key name for which to search.
type (out Type)Type of the last value passed to Set... or Get... for the specified setting.

TryGetSize

#Since v6.0
public bool TryGetSize(string key, out Size value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out Size)
legacyKeyList (IEnumerable<string>)

TryGetSize

#Since v5.0
public bool TryGetSize(string key, out Size value)
Parameters:
key (string)
value (out Size)

TryGetString

#Since v6.0
public bool TryGetString(string key, out string value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out string)
legacyKeyList (IEnumerable<string>)

TryGetString

#Since v5.0
public bool TryGetString(string key, out string value)
Parameters:
key (string)
value (out string)

TryGetStringDictionary

#
public bool TryGetStringDictionary(string key, out KeyValuePair<string, string>[] value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out KeyValuePair<string, string>[])
legacyKeyList (IEnumerable<string>)

TryGetStringDictionary

#
public bool TryGetStringDictionary(string key, out KeyValuePair<string, string>[] value)
Parameters:
key (string)
value (out KeyValuePair<string, string>[])

TryGetStringList

#Since v6.0
public bool TryGetStringList(string key, out string[] value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out string[])
legacyKeyList (IEnumerable<string>)

TryGetStringList

#Since v5.0
public bool TryGetStringList(string key, out string[] value)
Parameters:
key (string)
value (out string[])

TryGetUnsignedInteger

#Since v6.0
[CLSCompliant(false)] public bool TryGetUnsignedInteger(string key, out uint value, IEnumerable<string> legacyKeyList)
Parameters:
key (string)
value (out uint)
legacyKeyList (IEnumerable<string>)

TryGetUnsignedInteger

#Since v5.0
[CLSCompliant(false)] public bool TryGetUnsignedInteger(string key, out uint value)
Parameters:
key (string)
value (out uint)