Version

HierarchicalObjectCollection Class Members

The following tables list the members exposed by HierarchicalObjectCollection.

Protected Fields
Public Properties
 NameDescription
Public PropertyCapacityGets or sets the number of elements that the System.Collections.CollectionBase can contain. (Inherited from System.Collections.CollectionBase)
Public PropertyCountGets the number of elements contained in the System.Collections.CollectionBase instance. This property cannot be overridden. (Inherited from System.Collections.CollectionBase)
Public PropertyIsReadOnlyReturns true if the collection is read-only (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Public PropertyItemThis method is used primarily by control developers and derivations of existing controls. Indexer for the HierarchicalObjectCollection  
Public PropertyOwnerThis method is used primarily by control developers and derivations of existing controls. Each HierarchicalObjectCollection is owned by a HierarchicalUIObject. For example, a Nodes collection in a Tree is owned by a particular Node. The owner Node is then the Parent of each Node within the HierarchicalObjectCollection. The nodes at the root level of the tree are owned by a hidden Owner which is also referred to as the RootItem. In this way, the tree of HierarchicalObjectCollections is referred to as being single rooted.  
Protected Properties
 NameDescription
Protected PropertyHasViewStateJournal (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected PropertyInnerListGets an System.Collections.ArrayList containing the list of elements in the System.Collections.CollectionBase instance. (Inherited from System.Collections.CollectionBase)
Protected PropertyListGets an System.Collections.IList containing the list of elements in the System.Collections.CollectionBase instance. (Inherited from System.Collections.CollectionBase)
Protected PropertyViewStateJournalThe parent owner to which this object belongs. (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Public Methods
 NameDescription
Public MethodClearOverloaded. Clears the ObjectCollection of its contents and removes any associated Controls from the control tree. (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Public MethodContainsReturns true if the collection contains this item (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Public MethodGetEnumeratorReturns an enumerator that iterates through the System.Collections.CollectionBase instance. (Inherited from System.Collections.CollectionBase)
Public MethodIndexOfReturns the index of the object in the collection (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Public MethodRemoveOverloaded. Removes the specified item from the collection  
Public MethodRemoveAtRemoves the HierarchicalUIObject within the collection that corresponds to the supplied index.  
Public MethodSetDirtyMarks the ViewState of every object in the collection as Dirty so that it gets stored for round tripping to the client and back. (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected Methods
 NameDescription
Protected MethodCreateViewStateJournal (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodInternalAddAppends the object to the collection (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodInternalClearOverloaded. Clears the internal collection data structure (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodInternalMoveMoves an item from one index to another within the collection (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodInternalRemoveOverloaded. Removes an item from the collection (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodLoadViewState (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodLoadViewStateItems (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodOnClearClears associated Templates when the collection is cleared. (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodOnClearCompletePerforms additional custom processes after clearing the contents of the System.Collections.CollectionBase instance. (Inherited from System.Collections.CollectionBase)
Protected MethodOnInsertPerforms additional custom processes before inserting a new element into the System.Collections.CollectionBase instance. (Inherited from System.Collections.CollectionBase)
Protected MethodOnInsertCompleteOverridden. This method is used primarily by control developers and derivations of existing controls. Called by the framework when an object has been inserted, or added, to the collection. This method ensures that the inserted object has the appropriate owner assigned to it.  
Protected MethodOnRemoveClears associated Template when an object is removed from the collection. (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodOnRemoveCompletePerforms additional custom processes after removing an element from the System.Collections.CollectionBase instance. (Inherited from System.Collections.CollectionBase)
Protected MethodOnSetPerforms additional custom processes before setting a value in the System.Collections.CollectionBase instance. (Inherited from System.Collections.CollectionBase)
Protected MethodOnSetCompletePerforms additional custom processes after setting a value in the System.Collections.CollectionBase instance. (Inherited from System.Collections.CollectionBase)
Protected MethodOnValidateValidates that the value is not null. (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodSaveViewState (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
Protected MethodSaveViewStateItems (Inherited from Infragistics.Web.UI.Framework.ObjectCollection)
See Also