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
Spotfire.Dxp.Application.AnalyticItemsBookmarkManager
Namespace: Spotfire.Dxp.Application.AnalyticItems
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 66.0.19621.1485 (66.0.19621.1485)
Syntax
C#
public sealed class BookmarkManager : IDisposable, IServiceProvider
The BookmarkManager type exposes the following members.
Properties
Name | Description | |
---|---|---|
![]() | Links |
Gets a collection of methods for retrieving analysis and
bookmark uris of different types.
|
Methods
Name | Description | |
---|---|---|
![]() | AddNew(String) |
Adds a new bookmark for the active page.
|
![]() | AddNew(String, BookmarkComponentFlags) |
Adds a new bookmark for the specified components on the active page.
|
![]() | Apply(Guid) |
Applies the bookmark with the specified id on the current document.
|
![]() | Apply(Bookmark) |
Applies the specified bookmark to the document.
|
![]() | Apply(Bookmark, BookmarkComponentFlags) |
Applies the components of the specified bookmark to the document.
|
![]() | CanApply(Bookmark) |
Determines whether all components of the specified bookmark can be fully applied.
|
![]() | CanApply(Bookmark, BookmarkComponentFlags) |
Determines whether the specified components of the bookmark can be fully applied.
|
![]() | Dispose |
Releases all resources managed by the BookmarkManager.
|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetBookmarks |
Gets all the bookmarks in the document.
|
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetService(Type) |
Gets the service of the specified type.
|
![]() | GetServiceTService |
Gets the service of the specified type.
|
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | Remove |
Removes the specified bookmark from the document.
|
![]() | SavePrivateCopy |
Saves a private copy of the specified bookmark.
|
![]() | Search |
Gets all bookmarks matching the specified expression.
|
![]() | SetName |
Sets the name on the specified bookmark. The specified bookmark is removed and a copy of it, with the new name, is returned.
|
![]() | SetPublicVisibility |
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.
|
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | TryGetBookmark |
Tries to get the bookmark specified by id.
|
![]() | Update |
Updates the specified bookmark to reflect the active page.
|
Events
Name | Description | |
---|---|---|
![]() | BookmarksChanged |
Raised when there are new bookmarks available, or bookmarks have been removed.
The event is raised on the application thread.
|
Extension Methods
Name | Description | |
---|---|---|
![]() | GetServiceTService |
Convenience generic extension method that calls GetService(Type) and casts the result.
(Defined by Extensions.) |
Version Information
Supported in: 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