A collection of index page references.
Methods
PageReferenceadd (source:
Text[, pageReferenceType:
PageReferenceType=CURRENT_PAGE ][, pageReferenceLimit:
any][, pageNumberStyleOverride:
CharacterStyle][, withProperties:
Object])
Creates a new page reference.
| Parameter | Type | Description |
|---|---|---|
| source | Text | The text or insertion point to which the page reference points. |
| pageReferenceType | PageReferenceType : CURRENT_PAGE TO_NEXT_STYLE_CHANGE TO_NEXT_USE_OF_STYLE TO_END_OF_STORY TO_END_OF_DOCUMENT TO_END_OF_SECTION FOR_NEXT_N_PARAGRAPHS FOR_NEXT_N_PAGES SUPPRESS_PAGE_NUMBERS |
The page number for an index page reference or the last page in an index page reference page range. (Optional) (default: CURRENT_PAGE ) |
| pageReferenceLimit | ParagraphStyle Long Integer |
The paragraph style or number of paragraphs or pages that defines the last page in a page range. Valid only when page reference type specifies the next use of a paragraph style or a number of paragraphs or pages. . Can accept: ParagraphStyle or Long Integer. (Optional) |
| pageNumberStyleOverride | CharacterStyle | The style override for the page number. (Optional) |
| withProperties | Object | Initial values for properties of the new PageReference (Optional) |
PageReferenceanyItem ()
Returns any PageReference in the collection.
number count ()
Displays the number of elements in the PageReference.
Array of PageReferenceeveryItem ()
Returns every PageReference in the collection.
PageReferencefirstItem ()
Returns the first PageReference in the collection.
PageReferenceitem (index:
any)
Returns the PageReference with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
PageReferenceitemByID (id:
number)
Returns the PageReference with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
PageReferenceitemByName (name:
string)
Returns the PageReference with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of PageReferenceitemByRange (from:
any, to:
any)
Returns the PageReferences within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | PageReference Long Integer String |
The PageReference, index, or name at the beginning of the range. Can accept: PageReference, Long Integer or String. |
| to | PageReference Long Integer String |
The PageReference, index, or name at the end of the range. Can accept: PageReference, Long Integer or String. |
PageReferencelastItem ()
Returns the last PageReference in the collection.
PageReferencemiddleItem ()
Returns the middle PageReference in the collection.
PageReferencenextItem (obj:
PageReference)
Returns the PageReference whose index follows the specified PageReference in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | PageReference | The PageReference whose index comes before the desired PageReference. |
PageReferencepreviousItem (obj:
PageReference)
Returns the PageReference with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | PageReference | The index of the PageReference that follows the desired PageReference. |
string toSource ()
Generates a string which, if executed, will return the PageReference.
Element of:
Topic.pageReferences