PageReferences
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
PageReference [] (index:
number)
Returns the PageReference with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
PageReference add (source:
Text[, pageReferenceType:
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: PageReferenceType.CURRENT_PAGE PageReferenceType.TO_NEXT_STYLE_CHANGE PageReferenceType.TO_NEXT_USE_OF_STYLE PageReferenceType.TO_END_OF_STORY PageReferenceType.TO_END_OF_DOCUMENT PageReferenceType.TO_END_OF_SECTION PageReferenceType.FOR_NEXT_N_PARAGRAPHS PageReferenceType.FOR_NEXT_N_PAGES PageReferenceType.SUPPRESS_PAGE_NUMBERS | The page number for an index page reference or the last page in an index page reference page range. (Optional) (default: PageReferenceType.CURRENT_PAGE) |
| pageReferenceLimit | Long Integer ParagraphStyle | 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) |
PageReference anyItem ()
Returns any PageReference in the collection.
number count ()
Displays the number of elements in the PageReference.
Array of PageReference everyItem ()
Returns every PageReference in the collection.
PageReference firstItem ()
Returns the first PageReference in the collection.
PageReference item (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. |
PageReference itemByID (id:
number)
Returns the PageReference with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
PageReference itemByName (name:
string)
Returns the PageReference with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of PageReference itemByRange (from:
any, to:
any)
Returns the PageReferences within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer PageReference String | The PageReference, index, or name at the beginning of the range. Can accept: PageReference, Long Integer or String. |
| to | Long Integer PageReference String | The PageReference, index, or name at the end of the range. Can accept: PageReference, Long Integer or String. |
PageReference lastItem ()
Returns the last PageReference in the collection.
PageReference middleItem ()
Returns the middle PageReference in the collection.
PageReference nextItem (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. |
PageReference previousItem (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
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |