AnalysisApplication Members TIBCO Spotfire 6.5 API Reference
The AnalysisApplication type exposes the following members.
Methods

  NameDescription
Public methodClose
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 ClosingEventArgs T  are invoked before the document is closed.
Public methodCreateDataWriter
Creates the data writer given the typeId.
Public methodCreateFileDataSource
Creates the file data source from a path.
Public methodExit
Instructs this analysis application instance to exit.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetService(Type)
Gets the service object of the specified type.
Public methodGetService T  
Gets an instance of the requested service type.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodOpen(String)
Opens an analysis from the specified file, using the best matching reader. Any currently open document will be closed.
Public methodOpen(DataSource)
Opens a new document with data loaded from the specified source. Any currently open document will be closed.
Public methodOpen(String, DocumentOpenSettings)
Opens an analysis from the specified file, using the best matching reader. Any currently open document will be closed.
Public methodOpen(DataSource, DocumentOpenSettings)
Opens a new document with data loaded from the specified source. Any currently open document will be closed.
Public methodOpen(LibraryItem, DocumentOpenSettings)
Open the specified analysis or information link from the library.
Public methodOpenFromLibrary(Guid, DocumentOpenSettings)Obsolete.
Opens a library entry given the unique id (GUID) of that entry.
Public methodOpenFromLibrary(String, String)Obsolete.
Opens a file from the TIBCO Spotfire Server library with a known name located at a known path.
Public methodOpenFromLibrary(String, String, DocumentOpenSettings)Obsolete.
Opens a file from the TIBCO Spotfire Server library with a known name located at a known path.
Public methodSave 
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.
Public methodSave(String)Obsolete.
Saves the currently opened Document, if any, to the file given by fileName.
Public methodSave(String, DocumentSaveSettings)Obsolete.
Saves the currently opened Document, if any, to the file given by fileName.
Public methodSaveAs(String, DocumentSaveSettings)
Saves the currently loaded document to the specified file name.
Public methodSaveAs(LibraryItem, String, LibraryItemMetadataSettings, DocumentSaveSettings)
Saves the currently loaded document to the library with the specified title in the specified folder.
Public methodSaveCopy(String, DocumentSaveSettings)
Saves a copy of the currently loaded document to the specified file name.
Public methodSaveCopy(LibraryItem, String, LibraryItemMetadataSettings, DocumentSaveSettings)
Saves a copy of the currently loaded document to the library with the specified title in the specified folder.
Public methodSaveToLibrary(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.
Public methodSaveToLibrary(String, String, String, String)Obsolete.
Saves the current document in the TIBCO Spotfire Server Library.
Public methodSaveToLibrary(String, String, String, String, Boolean, DocumentSaveSettings)Obsolete.
Saves the current document in the TIBCO Spotfire Server Library and overwrites an existing document if necessary.
Back to Top
Properties

  NameDescription
Public propertyDocument
Gets the analysis document if one such has been opened; otherwise null is returned.
Public propertyDocumentMetadata
Gets the analysis document metadata.
Public propertyImportContext
Get the import context.
Public propertyToolbox
Gets the toolbox containing the tools available to the application.
Back to Top
Events

  NameDescription
Public eventDocumentChanged
Occurs when the Document property has changed. That is, the document has been closed or a new document has been opened.
Public eventDocumentClosing
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(ClosingEventArgs T  CloseAction). The typical responsibility of a close action is to tear down views of the document, which includes disposing ExternalEventManagers.
Public eventDocumentSaving
Raised before the Document is saved.
Public eventExiting
Raised before this analysis application instance exits.
Back to Top
See Also