LibraryLinksTryGetUri Method

Spotfire 14.7 API Reference
Tries to get a uri for a Spotfire analysis of the specified library item. The uri returned uses the TIBCOSpotfire protocol.

Namespace:  Spotfire.Dxp.Framework.Library
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 69.0.21424.2902 (69.0.21424.2902)
Syntax
C#
Copy
public bool TryGetUri(
	LibraryItem item,
	LibraryLinksOption option,
	out Uri uri
)

Parameters

item
Type: Spotfire.Dxp.Framework.LibraryLibraryItem
The library item to retrieve the Spotfire analysis uri for.
option
Type: Spotfire.Dxp.Framework.LibraryLibraryLinksOption
The option for generating the resulting uri.
uri
Type: SystemUri
The Spotfire analysis uri for the specified library item.

Return Value

Type: Boolean
True if successfully created a uri for a Spotfire analysis; otherwise false.
Exceptions
ExceptionCondition
ArgumentNullExceptionIf item or option is null.
Version Information

Supported in: 14.7, 14.6, 14.5, 14.4, 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

LibraryLinks Class
Spotfire.Dxp.Framework.Library Namespace