A collection container for bookmarks.
Inheritance Hierarchy
Spotfire.Dxp.Framework.DocumentModelNode
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: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(2, 0)] public sealed class BookmarkCollection : DocumentNodeListBase<Bookmark>
The BookmarkCollection type exposes the following members.
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.) |
 | CreateEventRelay(PropertyName, StatelessDependencyDeclarer) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
| CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoableListT) |
Creates an UndoableListT and assigns it to the specified field.
The UndoableListT will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoableSetT) |
Creates an UndoableSetT and assigns it to the specified field.
The UndoableSetT will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) |
Creates an UndoableCrossReferencePropertyT and assigns it to the specified field.
The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoablePropertyT, T) |
Creates an UndoablePropertyT and assigns it to the specified field.
The UndoablePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
| CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) |
Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field.
The UndoableDictionaryTKey, TValue will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) |
Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field.
The UndoableKeyedCollectionTKey, TNode will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreateReadOnlyPropertyT |
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.) |
| CreateRuntimeConstantT |
Creates a runtime constant. A runtime constant is a property in the document model
whose value is computed once when first accessed. The value is then disposed
along with the DocumentNode.
(Inherited from DocumentNode.) |
| CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) | Obsolete.
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
| CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) |
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
| DeclareInternalEventHandlers | Override this method to declare handlers of internal events.
(Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) |
Deserializes an UndoableCrossReferencePropertyT with value of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) | (Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | (Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | (Inherited from DocumentNode.) |
| DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | (Inherited from DocumentNode.) |
| DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | (Inherited from DocumentNode.) |
| DeserializeReadOnlyPropertyT |
Deserializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| DuplicateSubtreeT | Returns a copy of the sub tree spanned from this node that
has the same outwards non-owning references. The returned copy will
be in state New and is intended to be attached to the document
immediately. (Inherited from DocumentNode.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetEnumerator |
Returns an enumerator that iterates through this collection.
(Inherited from DocumentNodeListBaseT.) |
| GetPersistedTypeName | Can be used in the deserialization constructor to get the type name that the class
corresponding to this class had when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
| GetPersistedVersion | Can be used in the deserialization constructor to get the persistence version that this class
was marked with when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
| GetService | Override this method to provide services accessible
from this node and its descendants.
If you can not provide the requested service, you should call
base.GetService which relays the request to the owner
or to the AnalysisApplication if no owner is set.
(Inherited from Node.) |
| 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.) |
| InternalAdd |
Adds an item to this collection.
(Inherited from DocumentNodeListBaseT.) |
| InternalClear |
Removes all items from this collection.
(Inherited from DocumentNodeListBaseT.) |
| InternalCopyTo |
Copies the elements to the array starting at the specified arrayIndex.
(Inherited from DocumentNodeListBaseT.) |
| InternalInsert |
Inserts an element into this collection at the specified index.
(Inherited from DocumentNodeListBaseT.) |
| InternalInsertRange |
InsertRange.
(Inherited from DocumentNodeListBaseT.) |
| InternalMove |
Moves the item at the specified index to a new location in the collection.
(Inherited from DocumentNodeListBaseT.) |
| InternalRemove |
Removes the first occurrence of a specific object from this collection.
(Inherited from DocumentNodeListBaseT.) |
| InternalRemoveAt |
Removes the element at the specified index.
(Inherited from DocumentNodeListBaseT.) |
| InternalRemoveRange |
RemoveRange.
(Inherited from DocumentNodeListBaseT.) |
| InternalReplaceAll | Replaces the contents of the list with the elements in the
specified collection.
(Inherited from DocumentNodeListBaseT.) |
| InternalSet | Sets the item at the specified index.
(Inherited from DocumentNodeListBaseT.) |
| InternalSort |
Sorts the elements in the collection using the specified ComparisonT delegate.
(Inherited from DocumentNodeListBaseT.) |
| InternalTransaction |
Starts an internal transaction on the document model by
executing the specified executor delegate.
(Inherited from DocumentNode.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Migrate |
Converts old (versions prior to 3.3) bookmarks into the new Spotfire bookmark format
and removes the old bookmarks.
|
| OnConfigure |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
| OnConfigured |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
| OnReconfigure |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
| OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
| Remove | Removes the specified bookmark.
|
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT) | Serializes an Undoable*Property with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT) | Serializes an UndoableList with values of type T
storing it in info with key list.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) | Serializes an UndoableProperty with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT) | Serializes an UndoableSet storing it in info
with key given by the property name of the set.
(Inherited from DocumentNode.) |
| SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue) | Serializes an UndoableDictionary storing it in info
with key given by the property name of the dictionary.
(Inherited from DocumentNode.) |
| SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) |
Serializes an UndoableKeyedCollectionTKey, TNode storing it in info
with key given by the property name of the keyedCollection.
(Inherited from DocumentNode.) |
| SerializeReadOnlyPropertyT |
Serializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| ToArray | Copies the elements of the collection to a new array.
(Inherited from DocumentNodeListBaseT.) |
| TryGetBookmark | Tries to get a bookmark specified by its id.
|
| ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
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.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | IEnumerableGetEnumerator |
Returns an enumerator that iterates through a collection.
(Inherited from DocumentNodeListBaseT.) |
| IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) |
| 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.) |
| ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) |
| ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Version Information
See Also