AnalysisApplication Class

Spotfire 14.3 API Reference

Represents the currently running 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.

The AnalysisApplication events.

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.ApplicationAnalysisApplication

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

Syntax

Copy

[ToolContextAttribute]
public abstract class AnalysisApplication : IServiceProvider, 
	IDisposable

The AnalysisApplication type exposes the following members.

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.

Top

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.
	Dispose	Disposes private member resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	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.)
	GetHashCode	Serves as the default hash function. (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 Spotfire Server library with a known name located at a known path.
	OpenFromLibrary(String, String, DocumentOpenSettings)	Obsolete. Opens a file from the Spotfire Server library with a known name located at a known path.
	ReapplyStateCore	Used for reapplying state in Web Player.
	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 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 Spotfire Server Library.
	SaveToLibrary(String, String, String, String, Boolean, DocumentSaveSettings)	Obsolete. Saves the current document in the Spotfire Server Library and overwrites an existing document if necessary.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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.

Top

Extension Methods

	Name	Description
	GetServiceTService	Convenience generic extension method that calls GetService(Type) and casts the result. (Defined by Extensions.)

Top

Explicit Interface Implementations

	Name	Description
	IDisposableDispose	Releases resources used by the AnalysisApplication object.

Top

Remarks

New objects of this type cannot be created. Also, the one and only instance of this class is available throughout the entire lifetime of the running instance of the application as a service.

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Application Namespace