Class

PageReference

 The page reference for an index topic.

QuickLinks

addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Topic
PageReference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the PageReference.
indexnumber readonlyThe index of the PageReference within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the PageReference; this is an alias to the PageReference's label property.
pageNumberStyleOverrideCharacterStyle r/wThe character style applied to page numbers.
pageReferenceLimitLong Integer
ParagraphStyle
r/wThe 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.
pageReferenceTypePageReferenceType:
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/wOptions for index page references.
parentTopic readonlyThe parent of the PageReference (a Topic).
propertiesObject r/wA property that allows setting of several properties at the same time.
sourceTextText readonlyThe hyperlinked text or insertion point.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the PageReference.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the PageReference.

string toSpecifier ()
Retrieves the object specifier.

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.3hContents :: Index