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
Spotfire.Dxp.Framework.DocumentModelNode
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: 30.0.11525.4184 (30.0.11525.4184)
Syntax
C#
[SerializableAttribute] [PersistenceVersionAttribute(9, 0)] public sealed class PageCollection : DocumentNodeListBase<Page>
The PageCollection type exposes the following members.
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 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.) | |
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 DocumentNodeListBaseT.) | |
TryGetPage | Tries to get a page specified by its id.
|
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.) | |
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.
|
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