Sage Modeling and Simulation Library

TreeNodeHelper Members

The TreeNodeHelper type exposes the following members.

Constructors


  Name Description
Public method TreeNodeHelper
Creates a TreeNodeHelper with the indicated object as its ward. It is read-only or auto-indexed according to the

Methods


  Name Description
Protected method _OnAboutToGainChild
Protected method _OnAboutToLoseChild
Protected method _OnGainedChild
Protected method _OnLostChild
Protected method AboutToBeRemoved
Public method AddChild
Adds a child to this object. If the TreeNodeHelper is set to autoIndex, the new child must be an implementer of IHasIdentity, and will be indexed into the list of children.
Public method ClearChildren
Removes all children.
Public method CreateNodeWrapper
Creates a wrapper around the provided object that matches this one with respect to read-only and indexing settings.
Public method Equals
True if this treeNode helper's ward is equal to another object or another ITreeNodeHelper's ward object.
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetChild
Finds the child of this node that has the specified guid key.
Public method GetHashCode
Returns the hashCode of this TreeNodeHelper's ward object.
Public method GetRoot
Gets the root node at or above this node.
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.)
Public method RemoveChild
Removes a child from this object.
Public method ResequenceChildren
Sorts children according to the supplied IComparer.
Public method SetReadOnly
Sets this node's ReadOnly property to the new value.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)
Public method ToStringDeep
Produces a string representation of the entire tree below this node.
Protected method WasRemoved

Properties


  Name Description
Public property Children
The children of this object.
Public property IsLeaf
True if this implementer has no children.
Public property IsReadOnly
True if the tree cannot be reconfigured through this implementer (no adding/removing parents or children.)
Public property IsRoot
True if this implementer has no parent.
Public property Parent
The parent of this object.
Public property Ward
A TreeNode's Ward is the object it represents - the object that actually is conceptually a part of the tree being managed. If the object in the hierarchical tree inherits from TreeNodeHelper, then Ward is 'this'.

Events


  Name Description
Public event OnAboutToBeRemoved
Fires when this object is about to be removed from a parent's child list.
Public event OnAboutToGainChild
Fires when this object is about to gain a new member of it's child list.
Public event OnAboutToLoseChild
Fires when this object is about to lose a new member of it's child list.
Public event OnGainedChild
Fires after this object has gained a new member of it's child list.
Public event OnLostChild
Fires after this object has lost a new member of it's child list.
Public event OnWasRemoved
Fires after this object has been removed from a parent's child list.