ArchivableDictionary

ArchivableDictionary class

Represents a dictionary class that can be attached to objects and can be serialized (saved) at necessity. See remarks for layout.

Derived Classes:

Namespace: Rhino.Collections
ArchivableDictionary: references

Constructors (5)

ArchivableDictionary()

Initializes an instance of a dictionary for writing to a 3dm archive.

ArchivableDictionary(int version, string name)

Initializes an instance of a dictionary for writing to a 3dm archive.

ArchivableDictionary(int version)

Initializes an instance of a dictionary for writing to a 3dm archive.

ArchivableDictionary(SerializationInfo info, StreamingContext context)

Protected constructor for internal use.

ArchivableDictionary(UserData parentUserData)

Initializes an instance of a dictionary for writing to a 3dm archive

Properties (8)

ChangeSerialNumber

Retrieve current change serial number. This is a number that gets increased each time a datum is set or changed.

Count

Gets the number of key/value pairs contained in the dictionary.

Keys

Gets all entry names or keys.

Name

Gets or sets the name string of this ArchivableDictionary .

ParentUserData

If this dictionary is part of user-data (or is a UserDictionary), then this is the parent user data. None if this dictionary is not part of user-data

this[string

Gets the value associated with the specified key.

Values

Gets all values in this dictionary.

Version

Gets or sets the version of this ArchivableDictionary .

Methods (100)

AddContentsFrom(ArchivableDictionary source)

Add the contents from the source dictionary.

Clear()

Removes all keys and values from the dictionary.

Clone()

Constructs a deep copy of this object.

ContainsKey(String key)

Determines whether the dictionary contains the specified key.

GetBool(String key,Boolean defaultValue)

Get value as Boolean, will return defaultValue unless value was created using Set(string key, Boolean value)

GetBool(String key)

Get value as Boolean, will only succeed if value was created using Set(string key, Boolean value)

GetBytes(String key,Byte[] defaultValue)

Get value as byte[], will return defaultValue unless value was created using Set(string key, byte[] value)

GetBytes(String key)

Get value as byte[], will only succeed if value was created using Set(string key, byte[] value)

GetDictionary(String key, ArchivableDictionary defaultValue)

Get value as ArchivableDictionary, will return defaultValue unless value was created using Set(string key, ArchivableDictionary value)

GetDictionary(String key)

Get value as ArchivableDictionary, will only succeed if value was created using Set(string key, ArchivableDictionary value)

GetDouble(String key,Double defaultValue)

Get value as double, will only succeed if value was created using Set(string key, double value)

GetDouble(String key)

Get value as double, will only succeed if value was created using Set(string key, double value)

GetEnumerator()

Gets the enumerator of this dictionary.

GetEnumValue()

Get an enum value

GetEnumValue(String key)

Get an enum value from the dictionary using a custom key.

GetFloat(String key,Single defaultValue)

Get value as float, will return defaultValue unless value was created using Set(string key, float value)

GetFloat(String key)

Get value as float, will only succeed if value was created using Set(string key, float value)

GetGuid(String key,Guid defaultValue)

Get value as Guid, will return defaultValue unless value was created using Set(string key, Guid value)

GetGuid(String key)

Get value as Guid, will only succeed if value was created using Set(string key, Guid value)

Getint(String key,Int32 defaultValue)

Get value as int, will return defaultValue unless value was created using Set(string key, int value)

GetInteger(String key,Int32 defaultValue)

Get value as int, will return defaultValue unless value was created using Set(string key, int value)

GetInteger(String key)

Get value as int, will only succeed if value was created using Set(string key, int value)

GetObjectData(SerializationInfo info,StreamingContext context)

Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.

GetPlane(String key,Plane defaultValue)

Get value as Plane, will return defaultValue unless value was created using Set(string key, Plane value)

GetPlane(String key)

Get value as Plane, will return defaultValue unless value was created using Set(string key, Plane value)

GetPoint3d(String key,Point3d defaultValue)

Get value as Point3d, will return defaultValue unless value was created using Set(string key, Point3d value)

GetPoint3d(String key)

Get value as Point3d, will only succeed if value was created using Set(string key, Point3d value)

GetPoint3f(String key,Point3f defaultValue)

Get value as Point3f, will return defaultValue unless value was created using Set(string key, Point3f value)

GetPoint3f(String key)

Get value as Point3f, will only succeed if value was created using Set(string key, Point3f value)

GetString(String key,String defaultValue)

Get value as string, will return defaultValue unless value was created using Set(string key, string value)

GetString(String key)

Get value as string, will only succeed if value was created using Set(string key, string value)

GetVector3d(String key,Vector3d defaultValue)

Get value as Vector3d, will return defaultValue unless value was created using Set(string key, Vector3d value)

GetVector3d(String key)

Get value as Vector3d, will only succeed if value was created using Set(string key, Vector3d value)

Remove(String key)

Removes the value with the specified key from the dictionary.

RemoveEnumValue()

Remove an enum value from the dictionary.

ReplaceContentsWith(ArchivableDictionary source)

Replace the contents of the dictionary with that of the given source dictionary.

Set(String key, ArchivableDictionary val)

Sets another ArchivableDictionary as entry in this dictionary.

Set(String key,ObjRef val)

Sets a Rhino.DocObjects.ObjRef

Set(String key,BoundingBox val)

Sets a Rhino.Geometry.BoundingBox .

Set(String key,GeometryBase val)

Sets any class deriving from the Rhino.Geometry.GeometryBase base class.

Set(String key,Interval val)

Sets an Rhino.Geometry.Interval .

Set(String key,Line val)

Sets a Rhino.Geometry.Line .

Set(String key,MeshingParameters val)

Sets a Rhino.Geometry.MeshingParameters .

Set(String key,Plane val)

Sets a Rhino.Geometry.Plane .

Set(String key,Point2d val)

Sets a Rhino.Geometry.Point2d .

Set(String key,Point3d val)

Sets a Rhino.Geometry.Point3d .

Set(String key,Point3f val)

Sets a Rhino.Geometry.Point3f .

Set(String key,Point4d val)

Sets a Rhino.Geometry.Point4d .

Set(String key,Ray3d val)

Sets a Rhino.Geometry.Ray3d .

Set(String key,Transform val)

Sets a Rhino.Geometry.Transform .

Set(String key,Vector2d val)

Sets a Rhino.Geometry.Vector2d .

Set(String key,Vector3d val)

Sets a Rhino.Geometry.Vector3d .

Set(String key,Vector3f val)

Sets a Rhino.Geometry.Vector3f .

Set(String key, IEnumerable<bool> val)

Sets a list, an array or any enumerable of bool .

Set(String key, IEnumerable<byte> val)

Sets a list, an array or any enumerable of byte .

Set(String key, IEnumerable<double> val)

Sets a list, an array or any enumerable of double .

Set(String key, IEnumerable<float> val)

Sets a list, an array or any enumerable of float .

Set(String key, IEnumerable<GeometryBase> val)

Sets an array of Rhino.Geometry.GeometryBase

Set(String key, IEnumerable<Guid> val)

Sets a list, an array or any enumerable of Guid .

Set(String key, IEnumerable<int> val)

Sets a list, an array or any enumerable of int .

Set(String key, IEnumerable<ObjRef> val)

Sets an array of Rhino.DocObjects.ObjRef

Set(String key, IEnumerable<sbyte> val)

Sets a list, an array or any enumerable of sbyte .

Set(String key, IEnumerable<short> val)

Sets a list, an array or any enumerable of short .

Set(String key, IEnumerable<string> val)

Sets a list, an array or any enumerable of string .

Set(String key,Boolean val)

Sets a bool .

Set(String key,Byte val)

Sets a byte .

Set(String key,Double val)

Sets a double .

Set(String key,Color val)

Sets a System.Drawing.Color .

Set(String key,Font val)

Sets a System.Drawing.Font .

Set(String key,Point val)

Sets a System.Drawing.Point .

Set(String key,PointF val)

Sets a System.Drawing.PointF .

Set(String key,Rectangle val)

Sets a System.Drawing.Rectangle .

Set(String key,RectangleF val)

Sets a System.Drawing.RectangleF .

Set(String key,Size val)

Sets a System.Drawing.Size .

Set(String key,SizeF val)

Sets a System.Drawing.SizeF .

Set(String key,Guid val)

Sets a Guid .

Set(String key,Int16 val)

Sets a short .

Set(String key,Int32 val)

Sets a int .

Set(String key,Int64 val)

Sets a long .

Set(String key,SByte val)

Sets a sbyte .

Set(String key,Single val)

Sets a float .

Set(String key,String val)

Sets a string .

Set(String key,UInt16 val)

Sets a ushort .

Set(String key,UInt32 val)

Sets a uint .

SetEnumValue(String key, T enumValue)

Set an enum value in the dictionary with a custom key.

SetEnumValue(T enumValue)

Set an enum value

TryGetBool(String key,Boolean value)

Get value as Boolean, will only succeed if value was created using Set(string key, Boolean value)

TryGetBytes(String key,Byte[] value)

Get value as byte[], will only succeed if value was created using Set(string key, byte[] value)

TryGetDictionary(String key, out ArchivableDictionary value)

Get value as ArchivableDictionary, will only succeed if value was created using Set(string key, ArchivableDictionary value)

TryGetDouble(String key,Double value)

Get value as double, will only succeed if value was created using Set(string key, double value)

TryGetEnumValue(String key, out T enumValue)

Attempt to get an enum value from the dictionary using a custom key.

TryGetFloat(String key,Single value)

Get value as float, will only succeed if value was created using Set(string key, float value)

TryGetGuid(String key,Guid value)

Get value as Guid, will only succeed if value was created using Set(string key, Guid value)

TryGetInteger(String key,Int32 value)

Get value as int, will only succeed if value was created using Set(string key, int value)

TryGetPlane(String key,Plane value)

Get value as Plane, will only succeed if value was created using Set(string key, Plane value)

TryGetPoint3d(String key,Point3d value)

Get value as Point3d, will only succeed if value was created using Set(string key, Point3d value)

TryGetPoint3f(String key,Point3f value)

Get value as Point3f, will only succeed if value was created using Set(string key, Point3f value)

TryGetString(String key,String value)

Get value as string, will only succeed if value was created using Set(string key, string value)

TryGetValue(String key,Object value)

Gets the value associated with the specified key.

TryGetVector3d(String key,Vector3d value)

Get value as Vector3d, will only succeed if value was created using Set(string key, Vector3d value)

Nothing found