BookmarkLinks.TryGetUri Method

BookmarkLinks TryGetUri Method

TIBCO Spotfire 6.0 API Reference

Tries to get a uri for a TIBCO Spotfire analysis of the specified bookmark, which should be access through the TIBCOSpotfire protocol.

Namespace: Spotfire.Dxp.Application.AnalyticItems
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

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

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

Parameters

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

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

uri: Type: System Uri
The TIBCO Spotfire analysis uri for the specified bookmark.

Return Value

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

Exceptions

Exception	Condition
System ArgumentNullException	If bookmark or option is null.