UndoableDictionary<TKey, TValue> Class

Spotfire 14.5 API Reference
A dictionary where all operations are undoable.
Inheritance Hierarchy

System.Object
  Node
    UndoableNodeBase
      UndoableNode
        UndoableCollectionNode
          Spotfire.Dxp.Framework.DocumentModel.UndoableDictionary<TKey, TValue>

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

C#
[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class UndoableDictionary<TKey, TValue> : UndoableCollectionNode, 
	IDictionary<TKey, TValue>, ICollection<KeyValuePair<TKey, TValue>>, 
	IEnumerable<KeyValuePair<TKey, TValue>>, IEnumerable

Type Parameters

TKey
TValue

The UndoableDictionary<TKey, TValue> type exposes the following members.

Properties

  NameDescription
Public propertyCount
Gets the number of elements contained in the ICollection<T>.
Public propertyIsReadOnly
Gets a value indicating whether the ICollection<T> is read-only.
Public propertyItem
Gets or sets the TValue with the specified key.
Public propertyKeys
Gets an ICollection<T> containing the keys of the IDictionary<TKey, TValue>.
Public propertyValues
Gets an ICollection<T> containing the values in the IDictionary<TKey, TValue>.
Top
Methods

  NameDescription
Public methodAdd(KeyValuePair<TKey, TValue>)
Adds an item to the ICollection<T>.
Public methodAdd(TKey, TValue)
Adds an element with the provided key and value to the IDictionary<TKey, TValue>.
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 IDictionary<TKey, TValue> contains an element with the specified key.
Public methodCopyTo
Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.
Public methodGetEnumerator
Returns an enumerator that iterates through the collection.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemove(KeyValuePair<TKey, TValue>)
Removes the first occurrence of a specific object from the ICollection<T>.
Public methodRemove(TKey)
Removes the element with the specified key from the IDictionary<TKey, TValue>.
Public methodReplaceAll
Replaces the contents of this instance with the elements in the specified collection.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetValue
Tries to get the value associated with the specified key, returning true upon success.
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodIEnumerable.GetEnumerator
Returns an enumerator that iterates through a collection.
Top
Remarks

When the dictionary is modified, it will trigger a PropertyChanged event from its owner, using the PropertyName of the dictionary as the source.
Version Information

Supported in: 14.5, 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference