AnalysisApplication.Open Method (DataSource, DocumentOpenSettings)

AnalysisApplication Open Method (DataSource, DocumentOpenSettings)

TIBCO Spotfire 6.0 API Reference

Opens a new document with data loaded from the specified source. Any currently open document will be closed.

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

Syntax

C++

Copy to Clipboard Print

public virtual bool Open(
	DataSource source,
	DocumentOpenSettings settings
)

public virtual bool Open(
	DataSource source,
	DocumentOpenSettings settings
)

Parameters

source: Type: Spotfire.Dxp.Data DataSource
The data source from which data is to be opened.

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

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