Note: This API is now obsolete.
Opens a file from the TIBCO Spotfire Server library with a
known name located at a known path.
Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[ObsoleteAttribute("Use Open(LibraryItem, DocumentOpenSettings) instead.")] public virtual bool OpenFromLibrary( string path, string name, DocumentOpenSettings settings )
Parameters
- path
- Type: SystemString
The path of the directory in which the entry to open is located. - name
- Type: SystemString
The name of the library entry to open. - settings
- Type: Spotfire.Dxp.ApplicationDocumentOpenSettings
Controls how the document is opened.
Return Value
Type: Booleantrue if the document was loaded; otherwise false.
Exceptions
Exception | Condition |
---|---|
LibraryException |
no matching saved library entry with the given path and name is found. -or- the given document is not a valid TIBCO Spotfire analysis file. -or- the file contains linked data to import, but the import fails. -or- a communication error occurs when reading the document from the Library. |
InvalidOperationException | This method is not called from the application main thread. |
CanceledException | If the opening of the file is canceled by the user. |
ArgumentNullException | One of the arguments are null. |
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.
Examples
string path="/DXP Files/Sales"; string name="Sales February"; DocumentOpenSettings settings = new DocumentOpenSettings() bool loaded = application.OpenFromLibrary(path, name, settings);
string path="/DXP Files/Sales"; string name="Sales February"; DocumentOpenSettings settings = new DocumentOpenSettings() ProgressService progressService = application.GetService<ProgressService>(); progressService.ExecuteWithProgress("Opening from Library", "Opening " + name, delegate() { bool loaded = application.OpenFromLibrary(path, name, settings); });
Version Information
Obsolete (compiler warning) in 7.5
Obsolete (compiler warning) in 7.0
Obsolete (compiler warning) in 6.5
Obsolete (compiler warning) in 6.0
Obsolete (compiler warning) in 5.5
Obsolete (compiler warning) in 5.0
See Also