A collection of visual pages in an
analysis document. Note that new instances of this class
cannot be created. The one and only instance is accessed through the
Pages property of the
Document class.
The instance of this class can be used directly either to enumerate or to modify the visual pages in the document, that is, add new pages, remove pages, move pages, etc.
Inheritance Hierarchy
Node
Spotfire.Dxp.Framework.DocumentModel.DocumentNode
Spotfire.Dxp.Framework.DocumentModel.DocumentNodeListBase<Page>
Spotfire.Dxp.Application.PageCollection
Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 67.0.20819.4186 (67.0.20819.4186)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(9, 0)] public sealed class PageCollection : DocumentNodeListBase<Page>
The PageCollection 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 DocumentNodeListBase<T>.) |
![]() | IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) |
![]() | Item |
Gets the element at the specified index.
(Inherited from DocumentNodeListBase<T>.) |
![]() | NavigationMode | Gets or sets the page navigation mode (tabs or links) used to switch
between the pages of the document.
|
![]() | Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
![]() | VisualizationAreaSize |
Gets the settings that control the size of the visualization area.
|
Methods
Name | Description | |
---|---|---|
![]() | AddDuplicate | Creates a duplicate of the specified page and adds it to this
collection.
The duplicate page will become the active page.
|
![]() | AddNew() | Creates and adds a Page with a
localized default title to the document.
The page will become the active page.
|
![]() | AddNew(String) | Creates and adds a Page to the document.
The page will become the active page.
|
![]() | Clear |
Removes all pages from this collection.
|
![]() | Contains |
Determines whether the specified value is in this collection.
(Inherited from DocumentNodeListBase<T>.) |
![]() | ForEachNodeInSubTree<TNode> |
Applies the specified action to all nodes of the specified type in the subtree spanned
from this node, including this node.
(Inherited from DocumentNode.) |
![]() | GetEnumerator |
Returns an enumerator that iterates through this collection.
(Inherited from DocumentNodeListBase<T>.) |
![]() | 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 DocumentNodeListBase<T>.) |
![]() | Move |
Moves the item at the specified index to a new location in the collection.
|
![]() | MoveVisualTo | Moves a visual from its current Page to a new
page.
|
![]() | Remove |
Removes the specified Page
from this page collection.
|
![]() | RemoveAt |
Removes the page at the specified index
from this page collection.
|
![]() | ToArray | Copies the elements of the collection to a new array.
(Inherited from DocumentNodeListBase<T>.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | TryGetPage | Tries to get a page specified by its id.
|
Explicit Interface Implementations
Version Information
Supported in: 14.5, 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