Action
    Preparing search index...

    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 Spotfire.Dxp.Application.Document.Pages property of the Spotfire.Dxp.Application.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.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns null | T1

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    Item: PropertyGet<number | Int32, Page>

    Gets the element at the specified index.

    The zero-based index of the element to get.

    The element at the specified index.

    2.0

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Count(): number

      Gets the number of elements contained in this instance.

      Returns number

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

      Gets a collection of methods for executing transactions on the document.

      Returns ITransactions

      2.0

    • Creates and adds a Spotfire.Dxp.Application.Page with a localized default title to the document. The page will become the active page.

      Returns Page

      2.0

    • Creates and adds a Spotfire.Dxp.Application.Page to the document. The page will become the active page.

      Parameters

      • suggestedTitle: string | String

        A suggested title. A suffix will be added to the suggested title if it is not unique, that is, another visual page with the name exists. Note that only the first 1000 characters of the suggested title are considered when naming the new page.

      Returns Page

      The object model representation of the page that was added.

      2.0

    • Removes all pages from this collection.

      Returns void

      2.0

    • Determines whether the specified value is in this collection.

      Parameters

      • value: Page

        The object to locate in this collection. The value can be null.

      Returns boolean

      true if value is found in this collection; otherwise, false.

      2.0

    • Searches for the specified value and returns the zero-based index of the first occurrence within this collection.

      Parameters

      • value: Page

        The object to locate. The value can be null.

      Returns number

      The zero-based index of the first occurrence of value within this collection, if found; otherwise, -1.

      2.0

    • Moves the item at the specified index to a new location in the collection.

      Parameters

      • fromIndex: number | Int32

        The zero-based index specifying the location of the item to be moved.

      • toIndex: number | Int32

        The zero-based index specifying the new location of the item.

      Returns void

      2.0

    • Removes the specified Spotfire.Dxp.Application.Page from this page collection.

      Parameters

      • item: Page

        The page to remove.

      Returns boolean

      true if the page was successfully removed from this page collection, otherwise false. This method also returns false if the page is not found.

      2.0

    • Removes the page at the specified index from this page collection.

      Parameters

      • index: number | Int32

        The index of the page to remove.

      Returns void

      2.0

    • Tries to get a page specified by its id.

      Parameters

      Returns boolean

      true if the page was found, otherwise false.

      2.0