As soon as data has been opened in TIBCO 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 TIBCO 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.
Spotfire.Dxp.Framework.DocumentModelNode
Spotfire.Dxp.Framework.DocumentModelDocumentNode
Spotfire.Dxp.ApplicationDocument
Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 30.0.11525.4184 (30.0.11525.4184)
[SerializableAttribute] [PersistenceVersionAttribute(21, 0)] [ToolContextAttribute] public sealed class Document : DocumentNode, IDataPropertyContainerOwner, IDropVisualizationMemoryTriggerProvider, ILocaleTriggerProvider, IStyleSheetProvider
The Document type exposes the following members.
Name | Description | |
---|---|---|
ApplyUserPreferences | Applies the current user's preferences to a newly created
document.
| |
AutoConfigure | Configures a newly created document with reasonable default
values such as an intial page with a visualization on it and a filter
panel containing default filters for all columns and hierarchies.
| |
Export |
Exports the document to PDF using the settings and saves the result in the specified directory.
| |
GetReports |
Gets the prepared Reports saved in the document.
| |
GetStyle |
Gets the style properties for an element in the user interface.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
TryGetReport |
Tries to get the Report specified by name.
|
Name | Description | |
---|---|---|
ActiveDataTableReference | ||
ActiveFilteringSelectionReference | Gets the active filter. That is, the active
filtering of the active page if there is any. May return null.
| |
ActiveMarkingSelectionReference | Gets the active marking. That is, the active
marking of the active
Visual, if there is any. May return null.
| |
ActivePageReference | Gets or sets the currently active Page.
Note: This property can return null, but cannot be set to null. | |
ActiveVisualReference | ||
Bookmarks | Gets the collection of Bookmarks. The collection
can be used to create new bookmarks or to find and apply existing ones.
| |
Calculations |
Gets the collection of executions of calculations.
| |
ColoringTemplates | Gets the coloring templates.
| |
Context |
Gets the context of this node.
(Inherited from DocumentNode.) | |
CustomNodes | Gets the collection of custom nodes associated with this document.
| |
Data |
Gets the Data Manager, which can be used to access
the data contained in this document.
| |
FilteringSchemes |
Gets the collection of filter schemes in the document. The FilteringSchemeCollection can be
used to access and/or manipulate filters and filtering schemes.
| |
IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) | |
Pages | Gets the pages of this document.
| |
Properties |
Gets the document properties.
| |
ScriptManager |
Gets the script manger.
| |
Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) | |
UseLightTooltips |
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.
|
Name | Description | |
---|---|---|
IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) | |
INodeContextGetAncestorT |
Implements GetAncestorT.
(Inherited from DocumentNode.) | |
INodeContextGetServiceT |
Implements GetServiceT.
(Inherited from DocumentNode.) | |
INodeContextIsDescendantOf |
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.) | |
ITransactionsBeginAggregatedTransaction |
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.) | |
ITransactionsExecuteInvisibleTransaction |
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.) | |
ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) | |
ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |