PageReference

The page reference for an index topic.

Methods:

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Objects:

CharacterStyle, Number, Object, PageReferenceType, ParagraphStyle, String, Text,

Property Listing

Property

Type

Access

Description

id

Number

readonly

The unique ID of the PageReference.

index

Number

readonly

The index of the PageReference within its containing object.

label

String

read/write

A property that can be set to any string.

pageNumberStyleOverride

CharacterStyle

read/write

The character style applied to page numbers.

pageReferenceLimit

ParagraphStyle

Long

read/write

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.

pageReferenceType

PageReferenceType

PageReferenceType.CURRENT_PAGE

PageReferenceType.FOR_NEXT_N_PAGES

PageReferenceType.FOR_NEXT_N_PARAGRAPHS

PageReferenceType.SUPPRESS_PAGE_NUMBERS

PageReferenceType.TO_END_OF_DOCUMENT

PageReferenceType.TO_END_OF_SECTION

PageReferenceType.TO_END_OF_STORY

PageReferenceType.TO_NEXT_STYLE_CHANGE

PageReferenceType.TO_NEXT_USE_OF_STYLE

read/write

Options for index page references.

parent

Topic

readonly

The parent of the PageReference (a Topic).

properties

Object

read/write

A property that allows setting of several properties at the same time.

sourceText

Text

readonly

The hyperlinked text or insertion point.

Method Listing

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter

Type

Description

key

String

The key.

Object getElements ()

Resolves the object specifier, creating an array of object references.

undefined 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.

undefined remove ()

Deletes the PageReference.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Return

PageReferences.add()

PageReferences.anyItem()

PageReferences.everyItem()

PageReferences.nextItem()

PageReferences.previousItem()

PageReferences.itemByID()

PageReferences.item()

PageReferences.itemByName()

PageReferences.itemByRange()

PageReferences.firstItem()

PageReferences.lastItem()

PageReferences.middleItem()