BookmarkLinksTryGetWebPlayerUri Method

Spotfire 14.3 API Reference
Tries to get a uri for a Spotfire Web Player analysis with the specified bookmark, which should be accessed through http or https.

Namespace:  Spotfire.Dxp.Application.AnalyticItems
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
public bool TryGetWebPlayerUri(
	Bookmark bookmark,
	LibraryLinksOption option,
	out Uri uri
)

Parameters

bookmark
Type: Spotfire.Dxp.Application.AnalyticItemsBookmark
The bookmark to retrieve the Spotfire Web Player Player analysis uri for.
option
Type: Spotfire.Dxp.Framework.LibraryLibraryLinksOption
The option for generating the resulting uri.
uri
Type: SystemUri
The Spotfire Web Player analysis uri with the specified bookmark.

Return Value

Type: Boolean
True if successfully created a uri for a Spotfire Web Player analysis; otherwise false.
Exceptions
ExceptionCondition
ArgumentNullExceptionIf bookmark or option is null.
Remarks
Use Uri.AbsoluteUri on the resulting uri for a correct string representation if url encoded path are used.
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference

BookmarkLinks Class
Spotfire.Dxp.Application.AnalyticItems Namespace