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: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
public abstract bool Open( string filePath, DocumentOpenSettings settings )
Parameters
- filePath
- Type: SystemString
The path to the file to open. - settings
- Type: Spotfire.Dxp.ApplicationDocumentOpenSettings
Controls how the document is opened. For instance whether the document is auto configured.
Return Value
Type: BooleanThis 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 |
---|---|
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
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
See Also