PageReference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| id | number | readonly | The unique ID of the PageReference. |
| index | number | readonly | The index of the PageReference within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the PageReference; this is an alias to the PageReference's label property. |
| pageNumberStyleOverride | CharacterStyle | r/w | The character style applied to page numbers. |
| pageReferenceLimit | Long Integer ParagraphStyle |
r/w | The paragraph style or number of paragraphs or pages that defines the last page in a page range. Note: Valid only when page reference type specifies the next use of a paragraph style or a number of paragraphs or pages. . Can return: ParagraphStyle or Long Integer. |
| 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 |
r/w | Options for index page references. |
| parent | Topic | readonly | The parent of the PageReference (a Topic). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| sourceText | Text | readonly | The hyperlinked text or insertion point. |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of PageReference getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the PageReference.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the PageReference.
Used in:
PageReference PageReferences.nextItem (obj: PageReference)
PageReference PageReferences.previousItem (obj: PageReference)
Return
Array of PageReference PageReference.getElements ()
PageReference PageReferences.[] (index: number)
PageReference PageReferences.add (source: Text[, pageReferenceType: PageReferenceType=PageReferenceType.CURRENT_PAGE][, pageReferenceLimit: varies][, pageNumberStyleOverride: CharacterStyle][, withProperties: Object])
PageReference PageReferences.anyItem ()
Array of PageReference PageReferences.everyItem ()
PageReference PageReferences.firstItem ()
PageReference PageReferences.item (index: varies)
PageReference PageReferences.itemByID (id: number)
PageReference PageReferences.itemByName (name: string)
Array of PageReference PageReferences.itemByRange (from: varies, to: varies)
PageReference PageReferences.lastItem ()
PageReference PageReferences.middleItem ()
PageReference PageReferences.nextItem (obj: PageReference)
PageReference PageReferences.previousItem (obj: PageReference)
| Jongware, 28-Apr-2012 v3.0.3i | Contents :: Index |