Spotfire.Dxp.Framework.DocumentModel Namespace

TIBCO Spotfire 10.0 API Reference
The Spotfire.Dxp.Framework.DocumentModel namespace contains classes for managing the analysis document.
Classes

  ClassDescription
Public classAggregatedTransactionHandle
A handle to an aggregated transaction.
Public classClosingEventArgsT
Event arguments used for events that signal that the document is about to be closed.
Public classDocumentNode
Abstract base class for all Document Nodes.
Public classDocumentNodePropertyNames
The property names for DocumentNode. Base class for PropertyNames classes in all classes deriving from DocumentNode.
Public classDocumentNodeDictionaryTKey, TValue
Abstract base class for dictionary-like document nodes. It contains standard IListT methods to modify the collection.
Public classDocumentNodeDictionaryTKey, TValuePropertyNames
Public classDocumentNodeHandle
A handle to a document node.
Public classDocumentNodeHandleT
A typed handle to a document node of type T.
Public classDocumentNodeKeyedCollectionBaseTKey, TNode Obsolete.
Provides the abstract base class for a collection whose keys are embedded in the values.
Public classDocumentNodeKeyedCollectionBaseTKey, TNodePropertyNames
Public classDocumentNodeListT
Abstract base class for list-like document nodes. It contains standard IListT methods to modify the collection.
Public classDocumentNodeListBaseT
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 classDocumentNodeListBaseTPropertyNames
Public classDocumentNodeSetT
Base class for set-like document nodes.
Public classDocumentNodeSetTPropertyNames
Public classDocumentView
This class is used to control which view of the document that is used when getting and settings properties of the document model. A document has multiple views if the user has opened multiple browser tabs for the document in the web client, or if a javascript mashup uses multiple views.

Each view of the document can have different values for active page, active visualization, active data table, active marking, and active filtering selection. The value of these properties depends on the currently active view of the document. This class provides the API for getting and setting the current view of the document. We will refer to these properties as view properties.

The current document view is stored in a thread static variable and is thus associated with the current thread.

Public classExternalEventManager
A manager for external event handlers.
Public classImmutableAttribute
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 classInternalEventManager
A manager for internal event handlers.
Public classPropertyName
Represents the identity of a property on a DocumentNode.
Public classRollbackException
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 classRuntimeConstantT
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 classRuntimePropertyT
Holds a value that is lazily computed when accessed.
Public classTrigger
The abstract base class for triggers.
Public classTypeIdentifier
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 classTypeIdentifiers
Base class for TypeIdentifier definitions.
Public classUndoableCrossReferencePropertyT
Manages a property that does not own its value. Assignments to the property will be recorded as undoable commands.
Public classUndoableDictionaryTKey, TValue
A dictionary where all operations are undoable.
Public classUndoableKeyedCollectionTKey, TNode
An undoable collection of document nodes that behaves like a hybrid between a list and a dictionary.
Public classUndoableListT
A list of T where all operations on the list are undoable.
Public classUndoablePropertyT
Manages a property that owns its value and where assignments to the property will be recorded as undoable commands.
Public classUndoableSetT
A set of items where all operations are undoable.
Interfaces

  InterfaceDescription
Public interfaceINodeContext
An interface which declares methods for accessing the context of a node.
Public interfaceITransactions
Declares methods for executing transactions on the document.
Delegates

  DelegateDescription
Public delegateClosingEventArgsTCloseAction
The delegate type used for close actions.
Public delegateDependencyDeclarer Obsolete.
Public delegateExecutor
The type of delegates passed to the ITransactions methods.
Public delegateExternalEventHandler
The type of external event handlers.
Public delegateInternalEventHandler
The type of an internal event handler.
Public delegatePropertyComputerT
Public delegateReferenceTriggerDeclarerT
Delegate that shall compute a Trigger. Used by MutablePropertyTrigger.
Public delegateStatelessDependencyDeclarer
A delegate that declares the dependencies of an EventRelay and RuntimePropertyT given the document node that owns the runtime property or event relay.
Public delegateStatelessPropertyComputerT
Enumerations

  EnumerationDescription
Public enumerationEventRelayMode
Controls how the event relay propagates events in the different views of the document. A document has multiple views if the user has opened multiple browser tabs for the document in the web client, or if a javascript mashup uses multiple views.

Each view of the document can have different values for active page, active visualization, active data table, active marking, and active filtering selection. The value of these properties depends on the currently active view of the document. This type is used to control how events from these properties are propagated. See DocumentView for further documentation.

Public enumerationInternalEventExecutionMode
Controls how an internal event handler should be executed in the different views of the document. A document has multiple views if the user has opened multiple browser tabs for the document in the web client, or if a javascript mashup uses multiple views.

Each view of the document can have different values for active page, active visualization, active data table, active marking, and active filtering selection. The value of these properties depends on the currently active view of the document. We will refer to these properties as view properties.