LibraryLinksTryGetUri Method

Spotfire 15.0 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: 71.0.22122.5390 (71.0.22122.5390)
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


See Also

Reference

LibraryLinks Class
Spotfire.Dxp.Framework.Library Namespace