PageCollection Class

 Spotfire 14.3 API Reference
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
SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Framework.DocumentModelDocumentNodeListBasePage
        Spotfire.Dxp.ApplicationPageCollection

Namespace:  Spotfire.Dxp.Application
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
[SerializableAttribute]
[PersistenceVersionAttribute(9, 0)]
public sealed class PageCollection : DocumentNodeListBase<Page>

The PageCollection type exposes the following members.

Properties
  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyCount
Gets the number of elements contained in this instance.
(Inherited from DocumentNodeListBaseT.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyItem
Gets the element at the specified index.
(Inherited from DocumentNodeListBaseT.)
Public propertyNavigationMode
Gets or sets the page navigation mode (tabs or links) used to switch between the pages of the document.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyVisualizationAreaSize
Gets the settings that control the size of the visualization area.
Top
Methods
  NameDescription
Public methodAddDuplicate
Creates a duplicate of the specified page and adds it to this collection. The duplicate page will become the active page.
Public methodAddNew
Creates and adds a Page with a localized default title to the document. The page will become the active page.
Public methodAddNew(String)
Creates and adds a Page to the document. The page will become the active page.
Public methodClear
Removes all pages from this collection.
Public methodContains
Determines whether the specified value is in this collection.
(Inherited from DocumentNodeListBaseT.)
Public methodGetEnumerator
Returns an enumerator that iterates through this collection.
(Inherited from DocumentNodeListBaseT.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIndexOf
Searches for the specified value and returns the zero-based index of the first occurrence within this collection.
(Inherited from DocumentNodeListBaseT.)
Public methodMove
Moves the item at the specified index to a new location in the collection.
Public methodMoveVisualTo
Moves a visual from its current Page to a new page.
Public methodRemove
Removes the specified Page from this page collection.
Public methodRemoveAt
Removes the page at the specified index from this page collection.
Public methodToArray
Copies the elements of the collection to a new array.
(Inherited from DocumentNodeListBaseT.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryGetPage
Tries to get a page specified by its id.
Top
Explicit Interface Implementations
  NameDescription
Explicit interface implementationPrivate methodIEnumerableGetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from DocumentNodeListBaseT.)
Explicit interface implementationPrivate methodINodeContextGetAncestorT
Implements GetAncestorT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT
Implements GetServiceT.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference

Spotfire.Dxp.Application Namespace
Spotfire.Dxp.ApplicationDocument