BookmarkLinks.TryGetWebPlayerUri Method

BookmarkLinks TryGetWebPlayerUri Method

TIBCO Spotfire 6.5 API Reference

Tries to get a uri for a TIBCO 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: 14.10.7525.5058 (14.10.7525.5058)

Syntax

C++

Copy to Clipboard Print

public bool TryGetWebPlayerUri(
	Bookmark bookmark,
	LibraryLinksOption option,
	out Uri uri
)

public bool TryGetWebPlayerUri(
	Bookmark bookmark,
	LibraryLinksOption option,
	out Uri uri
)

Parameters

bookmark: Type: Spotfire.Dxp.Application.AnalyticItems Bookmark
The bookmark to retrieve the TIBCO Spotfire Web Player Player analysis uri for.

option: Type: Spotfire.Dxp.Framework.Library LibraryLinksOption
The option for generating the resulting uri.

uri: Type: System Uri
The TIBCO Spotfire Web Player analysis uri with the specified bookmark.

Return Value

Type: Boolean
True if successfully created a uri for a TIBCO Spotfire Web Player analysis; otherwise false.

Exceptions

Exception	Condition
System ArgumentNullException	If 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: 6.5, 6.0, 5.5, 5.0, 4.5