AnalysisApplication.Open Method (String, DocumentOpenSettings)

AnalysisApplication Open Method (String, DocumentOpenSettings)

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 abstract bool Open(
	string filePath,
	DocumentOpenSettings settings
)

public abstract bool Open(
	string filePath,
	DocumentOpenSettings settings
)

Parameters

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

settings: Type: Spotfire.Dxp.Application DocumentOpenSettings
Controls how the document is opened. For instance whether the document is auto configured.

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.

Any modifications of the document specified by the settings, for instance AutoConfigure and ConfigurationBlockText are performed before the undo/redo framework is enabled.

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