AnalysisApplicationOpenFromLibrary Method (Guid, DocumentOpenSettings) TIBCO Spotfire 7.6 API Reference

Note: This API is now obsolete.

Opens a library entry given the unique id (GUID) of that entry.

Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
Copy
[ObsoleteAttribute("Use Open(LibraryItem, DocumentOpenSettings) instead.")]
public virtual bool OpenFromLibrary(
	Guid entryId,
	DocumentOpenSettings settings
)

Parameters

entryId
Type: SystemGuid
The id of the entry to load in TIBCO Spotfire.
settings
Type: Spotfire.Dxp.ApplicationDocumentOpenSettings
Controls how the document is opened. For instance whether the document is auto configured.

Return Value

Type: Boolean
true if the document was loaded; otherwise false.
Exceptions
ExceptionCondition
InvalidOperationException This method is not called from the application main thread.
CanceledException If the opening of the file is canceled by the user.
LibraryException no matching saved library entry with the given id exists.
-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 occurs when saving the document in the Library.
NotSupportedException This method is called in the Spotfire Web Player.
Remarks
This operation by default is not executed with progress, that is, no progress dialog is shown while the current document is being read from the library. Note that if the document in the library requires any prompting the prompts will be suppressed unless this operation is executed with progress.

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

Version Information

Obsolete (compiler warning) in 7.6
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

Reference

AnalysisApplication Class
OpenFromLibrary Overload
Spotfire.Dxp.Application Namespace