Document Class

Spotfire 14.4 API Reference
A document opened in a running instance of Spotfire is referred to as an Analysis Document. The document not only contains a series of metadata information (see DocumentMetadata), but it also contains references to the data itself (see DataManager), and to various other components being part of the document, such as pages, filterings, bookmarks, etc.

As soon as data has been opened in Spotfire, an instance of this class can be accessed through the Document property of the AnalysisApplication. This is regardless of whether the data was opened through the user interface or programmatically. Hence, new instances of this class cannot be created through calls to the constructor.

When a document is opened in Spotfire using the user interface, the document will be automatically configured to be ready for use. This includes creation of a new page and adding a default visualization to that page. When opening a document through the API, however, it is empty. To achieve the same result as opening the document through the user interface, a call to the AutoConfigure method must be made.

Implementation of the IAnalysisMetadataProvider interface for Document.
Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.ApplicationDocument

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

C#
[SerializableAttribute]
[PersistenceVersionAttribute(64, 0)]
[ToolContextAttribute]
public sealed class Document : DocumentNode, 
	IServiceProvider

The Document type exposes the following members.

Properties

  NameDescription
Public propertyActiveDataTableReference
Gets the active DataTable. That is, the active DataTable of the active Visual, if there is any. May return null.
Public propertyActiveFilteringSelectionReference
Gets the active filter. That is, the active filtering of the active page if there is any. May return null.
Public propertyActiveMarkingSelectionReference
Gets the active marking. That is, the active marking of the active Visual, if there is any. May return null.
Public propertyActivePageReference
Gets or sets the currently active Page.

Note: This property can return null, but cannot be set to null.

Public propertyActiveVisualReference
Gets the active Visual. That is, the active Visual of the active Page, if there is any. May return null.
Public propertyBookmarks
Gets the collection of Bookmarks. The collection can be used to create new bookmarks or to find and apply existing ones.
Public propertyCalculations
Gets the collection of executions of calculations.
Public propertyColoringTemplates
Gets the coloring templates.
Public propertyCompatibility
Gets settings for compatibility with older versions.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyCustomNodes
Gets the collection of custom nodes associated with this document.
Public propertyData
Gets the Data Manager, which can be used to access the data contained in this document.
Public propertyFilteringSchemes
Gets the collection of filter schemes in the document. The FilteringSchemeCollection can be used to access and/or manipulate filters and filtering schemes.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyPages
Gets the pages of this document.
Public propertyProperties
Gets the document properties.
Public propertyScriptManager
Gets the script manger.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyUseLightTooltips
Gets or sets a value controlling if tooltips are rendered using dark text on a light background (as in pre 4.0 versions), or light text on dark background.
Top
Methods

  NameDescription
Public methodApplyUserPreferences
Applies the current user's preferences to a newly created document.
Public methodAutoConfigure
Configures a newly created document with reasonable default values such as an initial page with a visualization on it and a filter panel containing default filters for all columns and hierarchies.
Public methodExport Obsolete.
Exports the document to PDF using the settings and saves the result in the specified directory.
Public methodGetReports
Gets the prepared Reports saved in the document.
Public methodGetStyle
Gets the style properties for an element in the user interface.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetReport
Tries to get the Report specified by name.
Top
Extension Methods

  NameDescription
Public Extension MethodGetServiceTService
Convenience generic extension method that calls GetService(Type) and casts the result.
(Defined by Extensions.)
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
Version Information

Supported in: 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