AnalysisApplicationOpen Method (DataSource)

 Spotfire 14.2 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: 64.0.19329.3263 (64.0.19329.3263)
Syntax
C#
Copy
public bool Open(
	DataSource source
)

Parameters

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

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
ExceptionCondition
ImportException If the import fails, for example the data reader is not able to provide the data to import.
CanceledException If the opening of the file is canceled by the user.
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: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference

AnalysisApplication Class
Open Overload
Spotfire.Dxp.Application Namespace