UndoableKeyedCollectionTKey, TNode Class

Spotfire 14.3 API Reference

An undoable collection of document nodes that behaves like a hybrid between a list and a dictionary.

Inheritance Hierarchy

SystemObject
  Node
    UndoableNodeBase
      UndoableNode
        UndoableCollectionNode
          Spotfire.Dxp.Framework.DocumentModelUndoableKeyedCollectionTKey, TNode

Namespace: Spotfire.Dxp.Framework.DocumentModel
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

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 UndoableKeyedCollectionTKey, TNode type exposes the following members.

Properties

	Name	Description
	Count	Gets the number of elements contained in the ICollectionT.
	ItemInt32	Gets or sets the TNode at the specified index.
	ItemTKey	Gets the element with the specified key.

Top

Methods

	Name	Description
	Add	Adds an item to the ICollectionT.
	AddRange	Adds the elements of the specified collection to the end of this instance.
	AsReadOnly	Returns a read-only IListT containing the elements in this collection.
	Clear	Removes all items from the ICollectionT.
	Contains	Determines whether the ICollectionT contains a specific value.
	ContainsKey	Determines whether the specified key contains key.
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
	Exists	Determines whether the List contains elements that match the conditions defined by the specified predicate.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Find	Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the collection.
	FindAll	Retrieves the all the elements that match the conditions defined by the specified predicate.
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetObjectData	Implements ISerializable. (Overrides UndoableCollectionNode.GetObjectData(SerializationInfo, StreamingContext).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Determines the index of a specific item in the IListT.
	Insert	Inserts an item to the IListT at the specified index.
	InsertRange	Inserts the elements of the specified collection at the specified index.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove(TKey)	Removes the element with the specified key, returning true if this instance contained an element with the specified key prior to the removal.
	Remove(TNode)	Removes the first occurrence of a specific object from the ICollectionT.
	RemoveAll	Removes all elements that match the conditions defined by the specified predicate.
	RemoveAt	Removes the IListT item at the specified index.
	RemoveRange	Remove count elements starting at position index. If count is zero, no elements are removed and no event is raised.
	ReplaceAll	Replaces the contents of this instance with the elements in the specified collection.
	Sort	Sorts the elements in this collection using the default comparer.
	Sort(IComparerTNode)	Sorts the elements in this collection using the specified comparer.
	Sort(ComparisonTNode)	Sorts the elements in this collection using the specified System.Comparison.
	Sort(Int32, Int32, IComparerTNode)	Sorts the elements in a range of collection using the specified comparer.
	ToArray	Copies the elements of this collection to a new array.
	ToCollection	Copies the elements of the UndoableKeyedCollection to a Collection
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetValue	Tries to get the element associated with the specified key, returning true upon success.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection.
	ICollectionTNodeIsReadOnly	Gets a value indicating whether the ICollectionT 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 UndoableListT) and a key. Each node in an UndoableKeyedCollection must have an UndoablePropertyT with value of type TKey. The value of that property can be used to efficiently access the nodes.

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Framework.DocumentModel Namespace

UndoableKeyedCollectionAddLanguageSpecificTextSet("LSTCCE9386C_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TKey, TNodeAddLanguageSpecificTextSet("LSTCCE9386C_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

UndoableKeyedCollectionTKey, TNode Class