BookmarkManager Class

Spotfire 14.2 API Reference
Manages the bookmarks in the document and in the library. The AnalysisApplication owns an instance of this class and provides it as a service.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Application.AnalyticItemsBookmarkManager

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

C#
public sealed class BookmarkManager : IDisposable, 
	IServiceProvider

The BookmarkManager type exposes the following members.

Properties

  NameDescription
Public propertyLinks
Gets a collection of methods for retrieving analysis and bookmark uris of different types.
Top
Methods

  NameDescription
Public methodAddNew(String)
Adds a new bookmark for the active page.
Public methodAddNew(String, BookmarkComponentFlags)
Adds a new bookmark for the specified components on the active page.
Public methodApply(Guid)
Applies the bookmark with the specified id on the current document.
Public methodApply(Bookmark)
Applies the specified bookmark to the document.
Public methodApply(Bookmark, BookmarkComponentFlags)
Applies the components of the specified bookmark to the document.
Public methodCanApply(Bookmark)
Determines whether all components of the specified bookmark can be fully applied.
Public methodCanApply(Bookmark, BookmarkComponentFlags)
Determines whether the specified components of the bookmark can be fully applied.
Public methodDispose
Releases all resources managed by the BookmarkManager.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetBookmarks
Gets all the bookmarks in the document.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetService(Type)
Gets the service of the specified type.
Public methodGetServiceTService
Gets the service of the specified type.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodRemove
Removes the specified bookmark from the document.
Public methodSavePrivateCopy
Saves a private copy of the specified bookmark.
Public methodSearch
Gets all bookmarks matching the specified expression.
Public methodSetName
Sets the name on the specified bookmark. The specified bookmark is removed and a copy of it, with the new name, is returned.
Public methodSetPublicVisibility
Sets the public visibility on the specified bookmark. The specified bookmark is removed and a copy of it, with the new public visibility value, is returned.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetBookmark
Tries to get the bookmark specified by id.
Public methodUpdate
Updates the specified bookmark to reflect the active page.
Top
Events

  NameDescription
Public eventBookmarksChanged
Raised when there are new bookmarks available, or bookmarks have been removed. The event is raised on the application thread.
Top
Extension Methods

  NameDescription
Public Extension MethodGetServiceTService
Convenience generic extension method that calls GetService(Type) and casts the result.
(Defined by Extensions.)
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference