Represents the currently running TIBCO Spotfire instance.
This object can therefore be used to control the running instance, for example
open files or replace data.
If an analysis file (DXP file) has been opened in the application, an object representing that document is available through Document.
Inheritance Hierarchy
Spotfire.Dxp.ApplicationAnalysisApplication
Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[ToolContextAttribute] public abstract class AnalysisApplication : IAnalysisApplication, IDisposable, IServiceProvider, IExpressionFunctionProvider
The AnalysisApplication type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | Close |
Closes the currently opened Document, if any.
A DocumentClosing event is raised before the document is closed.
If the close is not canceled, all close actions added to the
ClosingEventArgsT are invoked before the document is closed.
|
| CreateDataWriter | Creates the data writer given the typeId.
|
| CreateFileDataSource | Creates the file data source from a path.
|
| Exit |
Instructs this analysis application instance to exit.
|
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetService(Type) |
Gets the service object of the specified type.
|
| GetServiceT | Gets an instance of the requested service type.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Open(String) | Opens an analysis from the specified file, using the best
matching reader.
Any currently open document will be closed.
|
| Open(DataSource) | Opens a new document with data loaded from the specified source.
Any currently open document will be closed.
|
| Open(String, DocumentOpenSettings) | Opens an analysis from the specified file, using the best
matching reader.
Any currently open document will be closed.
|
| Open(DataSource, DocumentOpenSettings) | Opens a new document with data loaded from the specified source.
Any currently open document will be closed.
|
| Open(LibraryItem, DocumentOpenSettings) | Open the specified analysis or information link
from the library.
|
| OpenFromLibrary(Guid, DocumentOpenSettings) | Obsolete.
Opens a library entry given the unique id (GUID) of that entry.
|
 | OpenFromLibrary(String, String) | Obsolete.
Opens a file from the TIBCO Spotfire Server library with a
known name located at a known path.
|
| OpenFromLibrary(String, String, DocumentOpenSettings) | Obsolete.
Opens a file from the TIBCO Spotfire Server library with a
known name located at a known path.
|
| Save | Saves the current loaded document to its last save location.
This is not possible if the loaded document was not an analysis file
loaded from a file path or from the library.
|
| Save(String) | Obsolete. Saves the currently opened Document, if any, to the file given by
fileName.
|
| Save(String, DocumentSaveSettings) | Obsolete. Saves the currently opened Document, if any, to the file given by
fileName.
|
| SaveAs(String, DocumentSaveSettings) | Saves the currently loaded document to the specified
file name.
|
| SaveAs(LibraryItem, String, LibraryItemMetadataSettings, DocumentSaveSettings) | Saves the currently loaded document to the library
with the specified title in the specified folder.
|
| SaveCopy(String, DocumentSaveSettings) | Saves a copy of the currently loaded document to the specified
file name.
|
| SaveCopy(LibraryItem, String, LibraryItemMetadataSettings, DocumentSaveSettings) | Saves a copy of the currently loaded document to the library
with the specified title in the specified folder.
|
| SaveToLibrary(Guid, DocumentSaveSettings) | Obsolete.
Saves the current document in the TIBCO Spotfire Server Library
and overwrites an existing document. This operation can only be
used to overwrite an already existing document in the library.
|
| SaveToLibrary(String, String, String, String) | Obsolete.
Saves the current document in the TIBCO Spotfire Server Library.
|
| SaveToLibrary(String, String, String, String, Boolean, DocumentSaveSettings) | Obsolete.
Saves the current document in the TIBCO Spotfire Server Library
and overwrites an existing document if necessary.
|
Properties
| Name | Description | |
|---|---|---|
 | Document | Gets the analysis document if one such has been opened;
otherwise null is returned.
|
| DocumentMetadata | Gets the analysis document metadata.
|
| ImportContext | Get the import context.
|
| Toolbox | Gets the toolbox containing the tools available to the application.
|
Events
| Name | Description | |
|---|---|---|
 | DocumentChanged | Occurs when the Document property has changed. That is, the
document has been closed or a new document has been opened.
|
| DocumentClosing | Occurs when the Document is closing. All components
that listen to events from the document must also listen to this event with handlers that
only adds close actions using AddCloseAction(ClosingEventArgsTCloseAction).
The typical responsibility of a close action is to tear down views of the document, which includes
disposing ExternalEventManagers.
|
| DocumentSaving | Raised before the Document is saved.
|
| Exiting | Raised before this analysis application instance exits.
|
Remarks
Version Information
See Also