UserDictionary

Public Class

Defines the storage data class for a user dictionary.

Inheritance Hierarchy

System.Object
Rhino.DocObjects.Custom.UserData
Rhino.DocObjects.Custom.UserDictionary

Namespace: Rhino.DocObjects.Custom

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class UserDictionary : UserData

The UserDictionary type exposes the following members.

Constructors

Name

Description

---

Public Method

UserDictionary

Initializes a new instance of the UserDictionary class

---

Properties

Name

Description

---

Public Property

Description

Gets the text “RhinoCommon UserDictionary”.

(Overrides

UserData.Description

.)

---

Public Property

Dictionary

Gets the dictionary that is associated with this class.

This dictionary is unique.

---

Public Property

ShouldWrite

Writes this entity if the count is larger than 0.

(Overrides

UserData.ShouldWrite

.)

---

Public Property

Transform

Updated if user data is attached to a piece of geometry that is transformed and the virtual OnTransform() is not overridden. If you override OnTransform() and want Transform to be updated, then call the base class OnTransform() in your override. The default constructor sets Transform to the identity.

(Inherited from UserData.)

---

Methods

Name

Description

---

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

(Inherited from UserData.)

---

Protected Method

Dispose(Boolean)

For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

(Inherited from UserData.)

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

(Inherited from UserData.)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Protected Method

OnDuplicate

Clones the user data.

(Overrides

UserData.OnDuplicate(UserData)

.)

---

Protected Method

OnTransform

Is called when the object associated with this data is transformed. If you override this function, make sure to call the base class if you want the stored Transform to be updated.

(Inherited from UserData.)

---

Protected Method

Read

Is called to read this entity.

(Overrides

UserData.Read(BinaryArchiveReader)

.)

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Protected Method

Write

Is called to write this entity.

(Overrides

UserData.Write(BinaryArchiveWriter)

.)

---