CustomNodes Class

Spotfire 14.2 API Reference
Represents a collection of custom nodes.
Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.ApplicationCustomNodes

Namespace:  Spotfire.Dxp.Application
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class CustomNodes : DocumentNode

The CustomNodes type exposes the following members.

Properties

  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Top
Methods

  NameDescription
Public methodAdd
Adds the specified node.
Public methodAddNewIfNeededT
Adds a new node of the specified type if required. If a node of the specified type is already present in the collection, it is returned and nothing is added.
Public methodContains(Type)
Determines whether a CustomNode of the specified type exists in this collection.
Public methodContains(CustomNode)
Determines whether the specified CustomNode exists in this the collection.
Public methodContainsT
Determines whether a CustomNode of the specified type exists in this collection.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemove
Removes the specified node.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetNode(Type, CustomNode)
Tries to get the CustomNode of the specified type.
Public methodTryGetNodeT(T)
Tries to get the CustomNode of the specified type.
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Remarks

The collection cannot hold more than one instance of a specific custom node type. To store many instances of a certain node type, MyNode, do as follows:

Derive MyNode from DocumentNode instead of CustomNode. Then create a class MyNodeCollection that derives from CustomNode. Add a collection structure to MyNodeCollection (typically an UndoableList) that can hold instances of MyNode. Then simply add a single MyNodeCollection instance to the CustomNodeCollection.

Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference