KeyedValues

References
[IoId("00000000-7c1b-45a3-ba6b-9eea505e9a90")] public sealed class KeyedValues : IStorable
A class for maintaining a mutable and overwritable set of named values to be used inside document objects.

Constructors

KeyedValues

#
public KeyedValues()
Create a new empty, keyed value collection.

KeyedValues

#
public KeyedValues(IReader reader)
Deserialise a keyed value collection.
Parameters:
reader (IReader)

Properties

Count

#
public int Count { get; }
Gets the number of values stored.

Methods

Delete

#
public void Delete(string key)
Remove a specific named value.
Parameters:
key (string)Key of value to remove.

DeleteWildcard

#
public int DeleteWildcard(string keyPattern)
Remove all values whose name matches a wildcard string.
Parameters:
keyPattern (string)Wildcard for key removal.

Get

#
public bool Get(string key, bool default)
Get a boolean value.
Parameters:
key (string)
default (bool)

Get

#
public Color Get(string key, Color default)
Get an Eto colour value.
Parameters:
key (string)
default (Color)

Get

#
public DateTime Get(string key, DateTime default)
Get a date value.
Parameters:
key (string)
default (DateTime)

Get

#
public double Get(string key, double default)
Get a numeric value.
Parameters:
key (string)
default (double)

Get

#
public Guid Get(string key, Guid default)
Get a guid value.
Parameters:
key (string)
default (Guid)

Get

#
public int Get(string key, int default)
Get an integer value.
Parameters:
key (string)
default (int)

Get

#
public Point Get(string key, Point default)
Get an Eto point value.
Parameters:
key (string)
default (Point)

Get

#
public PointF Get(string key, PointF default)
Get an Eto point value.
Parameters:
key (string)
default (PointF)

Get

#
public Rectangle Get(string key, Rectangle default)
Get an Eto rectangle value.
Parameters:
key (string)
default (Rectangle)

Get

#
public RectangleF Get(string key, RectangleF default)
Get an Eto rectangle value.
Parameters:
key (string)
default (RectangleF)

Get

#
public Size Get(string key, Size default)
Get an Eto size value.
Parameters:
key (string)
default (Size)

Get

#
public SizeF Get(string key, SizeF default)
Get an Eto size value.
Parameters:
key (string)
default (SizeF)

Get

#
public string Get(string key, string default)
Get a text value.
Parameters:
key (string)
default (string)

Get<T>

#
public T Get<T>(string key, T default)
Get a Grasshopper IStorable instance.
Parameters:
key (string)
default (T)

Get

#
public TimeSpan Get(string key, TimeSpan default)
Get a time value.
Parameters:
key (string)
default (TimeSpan)

IsDefined

#
public bool IsDefined(string key)
Gets whether a value with a specific name has been set.
Parameters:
key (string)

Rename

#
public bool Rename(string oldKey, string newKey)
Rename a value.
Parameters:
oldKey (string)
newKey (string)

Set

#
public void Set(string key, bool value)
Set a boolean value.
Parameters:
key (string)
value (bool)

Set

#
public void Set(string key, Color value)
Set an Eto colour value.
Parameters:
key (string)
value (Color)

Set

#
public void Set(string key, DateTime value)
Set a date value.
Parameters:
key (string)
value (DateTime)

Set

#
public void Set(string key, double value)
Set a number value.
Parameters:
key (string)
value (double)

Set

#
public void Set(string key, Guid value)
Set a guid value.
Parameters:
key (string)
value (Guid)

Set

#
public void Set(string key, int value)
Set an integer value.
Parameters:
key (string)
value (int)

Set

#
public void Set(string key, IStorable value)
Set a GrasshopperIO storable value.
Parameters:
key (string)
value (IStorable)

Set

#
public void Set(string key, Point value)
Set an Eto point value.
Parameters:
key (string)
value (Point)

Set

#
public void Set(string key, PointF value)
Set an Eto point value.
Parameters:
key (string)
value (PointF)

Set

#
public void Set(string key, Rectangle value)
Set an Eto rectangle value.
Parameters:
key (string)
value (Rectangle)

Set

#
public void Set(string key, RectangleF value)
Set an Eto rectangle value.
Parameters:
key (string)
value (RectangleF)

Set

#
public void Set(string key, Size value)
Set an Eto size value.
Parameters:
key (string)
value (Size)

Set

#
public void Set(string key, SizeF value)
Set an Eto size value.
Parameters:
key (string)
value (SizeF)

Set

#
public void Set(string key, string value)
Set a text value.
Parameters:
key (string)
value (string)

Set

#
public void Set(string key, TimeSpan value)
Set a time value.
Parameters:
key (string)
value (TimeSpan)

Store

#
public void Store(IWriter writer)
Store this collection.
Parameters:
writer (IWriter)
Implements: Store

Transfer

#
public void Transfer(KeyedValues other, string keyPattern)
Transfer all values which match a key naming pattern from another collection. For a value to be transferred it must have identical keys in both collections.
Parameters:
other (KeyedValues)Collection to copy from.
keyPattern (string)Wildcard pattern for key matching.
Returns: Number of values copied.

Events

ValueChanged

#
public event EventHandler<KeyValueEventArgs> ValueChanged
Raised when a value is assigned or changed.

ValueDeleted

#
public event EventHandler<KeyValueEventArgs> ValueDeleted
Raised when a value is deleted.