UndoableKeyedCollection< TKey, TNode> Class TIBCO Spotfire 7.5 API Reference
An undoable collection of document nodes that behaves like a hybrid between a list and a dictionary.
Inheritance Hierarchy
System. Object
  Spotfire.Dxp.Framework.DocumentModel.Node
    Spotfire.Dxp.Framework.DocumentModel.UndoableNodeBase
      UndoableNode
        UndoableCollectionNode
          Spotfire.Dxp.Framework.DocumentModel.UndoableKeyedCollection<TKey, TNode>

Namespace: Spotfire.Dxp.Framework.DocumentModel
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 23.18.9504.3877 (23.18.9504.3877)
Syntax
C#
Copy
[SerializableAttribute]
public class UndoableKeyedCollection<TKey, TNode> : UndoableCollectionNode, 
	IList<TNode>, ICollection<TNode>, IEnumerable<TNode>, IEnumerable
where TNode : DocumentNode

Type Parameters

TKey
The type of key held by the nodes in the collection.
TNode
The type of the nodes in the collection.

The UndoableKeyedCollection< TKey, TNode> type exposes the following members.

Methods
  NameDescription
Public methodAdd
Adds an item to the ICollection<T>.
Public methodAddRange
Adds the elements of the specified collection to the end of this instance.
Public methodAsReadOnly
Returns a read-only IList< T> containing the elements in this collection.
Public methodClear
Removes all items from the ICollection<T>.
Public methodContains
Determines whether the ICollection< T> contains a specific value.
Public methodContainsKey
Determines whether the specified key contains key.
Public methodCopyTo
Copies the elements of the ICollection< T> to an Array, starting at a particular Array index.
Public methodExists
Determines whether the List contains elements that match the conditions defined by the specified predicate.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFind
Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the collection.
Public methodFindAll
Retrieves the all the elements that match the conditions defined by the specified predicate.
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
Protected methodGetService
Override this method to provide services accessible from this node and its descendants. If you can not provide the requested service, you should call base.GetService which relays the request to the owner or to the AnalysisApplication if no owner is set.
(Inherited from Node.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Determines the index of a specific item in the IList<T>.
Public methodInsert
Inserts an item to the IList< T> at the specified index.
Public methodInsertRange
Inserts the elements of the specified collection at the specified index.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodRemove(TKey)
Removes the element with the specified key, returning true if this instance contained an element with the specified key prior to the removal.
Public methodRemove(TNode)
Removes the first occurrence of a specific object from the ICollection<T>.
Public methodRemoveAll
Removes all elements that match the conditions defined by the specified predicate.
Public methodRemoveAt
Removes the IList< T> item at the specified index.
Public methodRemoveRange
Remove count elements starting at position index. If count is zero, no elements are removed and no event is raised.
Public methodReplaceAll
Replaces the contents of this instance with the elements in the specified collection.
Public methodSort()
Sorts the elements in this collection using the default comparer.
Public methodSort(IComparer<TNode>)
Sorts the elements in this collection using the specified comparer.
Public methodSort(Comparison<TNode>)
Sorts the elements in this collection using the specified System.Comparison.
Public methodSort(Int32, Int32, IComparer<TNode>)
Sorts the elements in a range of collection using the specified comparer.
Public methodToArray
Copies the elements of this collection to a new array.
Public methodToCollection
Copies the elements of the UndoableKeyedCollection to a Collection
Public methodTryGetValue
Tries to get the element associated with the specified key, returning true upon success.
Top
Properties
  NameDescription
Public propertyCount
Gets the number of elements contained in the ICollection<T>.
Public propertyItem[Int32]
Gets or sets the TNode at the specified index.
Public propertyItem[TKey]
Gets the element with the specified key.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIEnumerable.GetEnumerator
Returns an enumerator that iterates through a collection.
Explicit interface implementationPrivate methodIServiceProvider.GetService
Implements IServiceProvider.
(Inherited from Node.)
Explicit interface implementationPrivate propertyICollection<TNode>.IsReadOnly
Gets a value indicating whether the ICollection< T> is read-only.
Top
Remarks
An UndoableKeyedCollection is a list of document nodes that can be efficiently accessed both using the index in the list (just like an UndoableList<T>) and a key. Each node in an UndoableKeyedCollection must have an UndoableProperty< T> with value of type TKey. The value of that property can be used to efficiently access the nodes.
Version Information

Supported in: 7.5, 7.0, 6.5, 6.0, 5.5, 5.0
See Also

Reference

Spotfire.Dxp.Framework.DocumentModel Namespace