AnalysisApplication.Open Method (String)

AnalysisApplication Open Method (String)

TIBCO Spotfire 6.5 API Reference

Opens an analysis from the specified file, using the best matching reader. Any currently open document will be closed.

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

Syntax

C++

Copy to Clipboard Print

public bool Open(
	string filePath
)

public bool Open(
	string filePath
)

Parameters

filePath: Type: System String
The path to the file to open.

Return Value

Type: Boolean
This method always returns true. If there is an error during loading or if the user cancels a prompt, an exception is thrown.

Exceptions

Exception	Condition
Spotfire.Dxp.Data.Exceptions ImportException	If the import fails, for example the data reader is not able to provide the data to import.
Spotfire.Dxp.Framework.ApplicationModel CanceledException	If the opening of the file is canceled by the user.
System NotSupportedException	This method is called in the Spotfire Web Player.

Remarks

The operation is executed with progress information.

When a document is opened using a call to this method, the document will not be auto configured. This means that:

no default visual page is added
no default visualization is created
the user preferences (for example whether or not to show the cover page, the page visualization mode, the filter panel mode, etc.) are not be applied
the filter panel is not configured, that is, no filters are added.

All of these operations must be performed explicitly through calls to AutoConfigure , ApplyUserPreferences , and AutoConfigure , respectively.

This method is not supported in the Spotfire Web Player. Calling it there will cause a NotSupportedException to be thrown.

Version Information

Supported in: 6.5, 6.0, 5.5, 5.0, 4.5