BookmarkCollection Class

Spotfire 14.2 API Reference

A collection container for bookmarks.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Framework.DocumentModelDocumentNodeListBaseBookmark
        Spotfire.Dxp.ApplicationBookmarkCollection

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

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(2, 0)]
public sealed class BookmarkCollection : DocumentNodeListBase<Bookmark>

The BookmarkCollection type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	Count	Gets the number of elements contained in this instance. (Inherited from DocumentNodeListBaseT.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Item	Gets the element at the specified index. (Inherited from DocumentNodeListBaseT.)
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)

Top

Methods

	Name	Description
	AddNew(String, BookmarkComponentFlags)	Obsolete. Adds a new bookmark with the specified components.
	AddNew(String, BookmarkComponentFlags, String)	Obsolete. Adds a new bookmark with the specified components to the specified folder. If the folder does not exist, it is created.
	Contains	Determines whether the specified value is in this collection. (Inherited from DocumentNodeListBaseT.)
	GetEnumerator	Returns an enumerator that iterates through this collection. (Inherited from DocumentNodeListBaseT.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Searches for the specified value and returns the zero-based index of the first occurrence within this collection. (Inherited from DocumentNodeListBaseT.)
	Migrate	Converts old (versions prior to 3.3) bookmarks into the new Spotfire bookmark format and removes the old bookmarks.
	Remove	Removes the specified bookmark.
	ToArray	Copies the elements of the collection to a new array. (Inherited from DocumentNodeListBaseT.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TryGetBookmark	Tries to get a bookmark specified by its id.

Top

Explicit Interface Implementations

	Name	Description
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection. (Inherited from DocumentNodeListBaseT.)
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

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

Reference

Spotfire.Dxp.Application Namespace