HierarchySupportList Collection
Description
Services to create and maintains lists of items and their parent objects.
Remarks

Get a HierarchySupportList from HierarchyFilter.NewList. A HierarchySupportList is returned if HierarchyFilter.KeepHierarchical is true. Otherwise a FactoryList is returned.

The HierarchySupportList contains the objects at the top level of the search tree that match the filter, and those objects at the top level that have descendents that match the filter. To determine whether an item in the list matches the filter check the IsInFilter Property. If the property is false, the item does not match the filter, but has descendent that match.

To search for matches in a sub-tree, specify the root of the sub-tree with a filter on RQ_FATHER_ID. The search begins with the children of the specified node. The item having the specified RQ_FATHER_ID is not checked.

If there is no filter on RQ_FATHER_ID, the entire tree is searched. If any item matches, the list contains the root node of the tree.

Public Methods
Public Method AddAdds a new item to the current list object.Adds a new item to the current list object.
Public Method IndexOfItemGets the index of the passed object.Gets the index of the passed object.
Public Method InsertInserts a new item at the specified position.Inserts a new item at the specified position.
Public Method PostPosts changed data for all items in list.
Public Method RefreshReads saved list filter and data for all listed objects, overwriting values in memory.
Public Method RemoveRemoves the specified item from the current list object.Removes the specified item from the current list object.
Public Method SwapSwaps the two list items specified by their positions.Swaps the two list items specified by their positions.
Public Properties
Public Property _NewEnumGets an IEnumVARIANT enumerator. For information on the IEnumVARIANT, see Microsoft documentation.Gets an IEnumVARIANT enumerator. For information on the IEnumVARIANT, see Microsoft documentation.
Public Property CountThe number of items in the list.The number of items in the list.
Public Property FieldsGets a list of fields available through this factory.
Public Property IsInFilterChecks if the item matches the filter criteria of the list to which it belongs.
Public Property ItemGets an item by index. The index is one-based.Gets an item by index. The index is one-based.
Public Property RatioThe similarity ratio for the specified item.
Public Property TotalCountTotal result count, when fetch limit is used in filter.Total result count, when fetch limit is used in filter.
See Also