Spotfire.Dxp.Framework.DocumentModel Namespace TIBCO Spotfire 6.5 API Reference
The Spotfire.Dxp.Framework.DocumentModel namespace contains classes for managing the analysis document.
Classes
  Class Description
Public class AggregatedTransactionHandle
A handle to an aggregated transaction.
Public class ClosingEventArgs T 
Event arguments used for events that signal that the document is about to be closed.
Public class DocumentNode
Abstract base class for all Document Nodes.
Public class DocumentNode PropertyNames
The property names for DocumentNode. Base class for PropertyNames classes in all classes deriving from DocumentNode.
Public class DocumentNodeDictionary TKey, TValue 
Abstract base class for dictionary-like document nodes. It contains standard IList T  methods to modify the collection.
Public class DocumentNodeDictionary TKey, TValue  PropertyNames
Contains property name constants for the public properties of DocumentNodeDictionary TKey, TValue .
Public class DocumentNodeHandle
A handle to a document node.
Public class DocumentNodeHandle T 
A typed handle to a document node of type T.
Public class DocumentNodeKeyedCollectionBase TKey, TNode  Obsolete.
Provides the abstract base class for a collection whose keys are embedded in the values.
Public class DocumentNodeKeyedCollectionBase TKey, TNode  PropertyNames
Contains property name constants for the public properties of DocumentNodeKeyedCollectionBase TKey, TNode .
Public class DocumentNodeList T 
Abstract base class for list-like document nodes. It contains standard IList T  methods to modify the collection.
Public class DocumentNodeListBase T 
Abstract base class for list-like document nodes. It does not expose any public methods to modify the collection, it is up to derived classes to do so.
Public class DocumentNodeListBase T  PropertyNames
Contains property name constants for the public properties of DocumentNodeListBase T .
Public class DocumentNodeSet T 
Base class for set-like document nodes.
Public class DocumentNodeSet T  PropertyNames
Contains property name constants for the public properties of DocumentNodeSet T .
Public class ExternalEventManager
A manager for external event handlers.
Public class ImmutableAttribute
Types marked with this attribute are considered immutable by the fail-early check that requires that all values used in the document are immutable. IMPORTANT NOTE: Do not mark a type with an ImmutableAttribute if the state of an instance of the type can be manipulated after the instance has been constructed. Failure to follow this guideline may lead to undo/redo bugs and crashes.
Public class InternalEventManager
A manager for internal event handlers.
Public class Node
Base class for all nodes in the document.
Public class PropertyName
Represents the identity of a property on a DocumentNode.
Public class RollbackException
This exception is thrown if the document model framework fails to rollback the state of the document after an exception was thrown during a transaction.
Public class RuntimeConstant T 
Holds a constant value that is lazily computed when first accessed. If the value implements IDisposable, it is disposed when the owning DocumentNode is detached.
Public class RuntimeProperty T 
Holds a value that is lazily computed when accessed.
Public class Trigger
The abstract base class for triggers.
Public class TypeIdentifier
An instance of this class identifies a document node type. The identifier is valid between TIBCO Spotfire versions, whereas the actual Type of the node might change.
Public class TypeIdentifiers
Base class for TypeIdentifier definitions.
Public class UndoableCrossReferenceProperty T 
Manages a property that does not own its value. Assignments to the property will be recorded as undoable commands.
Public class UndoableDictionary TKey, TValue 
A dictionary where all operations are undoable.
Public class UndoableKeyedCollection TKey, TNode 
An undoable collection of document nodes that behaves like a hybrid between a list and a dictionary.
Public class UndoableList T 
A list of T where all operations on the list are undoable.
Public class UndoableProperty T 
Manages a property that owns its value and where assignments to the property will be recorded as undoable commands.
Public class UndoableSet T 
A set of items where all operations are undoable.
Interfaces
  Interface Description
Public interface INodeContext
An interface which declares methods for accessing the context of a node.
Public interface ITransactions
Declares methods for executing transactions on the document.
Delegates
  Delegate Description
Public delegate ClosingEventArgs T  CloseAction
The delegate type used for close actions.
Public delegate DependencyDeclarer Obsolete.
A delegate that declares the dependencies of a RuntimeProperty T .
Public delegate Executor
The type of delegates passed to the ITransactions methods.
Public delegate ExternalEventHandler
The type of external event handlers.
Public delegate InternalEventHandler
The type of an internal event handler.
Public delegate PropertyComputer T 
A delegate that computes the values of a RuntimeProperty T .
Public delegate ReferenceTriggerDeclarer T 
Delegate that shall compute a Trigger. Used by MutablePropertyTrigger.
Public delegate StatelessDependencyDeclarer
A delegate that declares the dependencies of an EventRelay and RuntimeProperty T  given the document node that owns the runtime property or event relay.
Public delegate StatelessPropertyComputer T 
A delegate that computes the value of a RuntimeProperty T  given the document node that owns the runtime property.