PageReferences

A collection of index page references.

Methods:

add, count

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

PageReference add (parentStory:Story, storyOffset:Varies InsertionPoint Long, [pageReferenceType:PageReferenceType=PageReferenceType], pageReferenceLimit:Varies ParagraphStyle Long, pageNumberStyleOverride:CharacterStyle, withProperties:Object)

Create a new page reference

Parameter

Type

Description

parentStory

Story

The parent story

storyOffset

InsertionPoint

Long

Offset within the story. Can accept: InsertionPoint 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

The type of page reference (Optional)

(default: PageReferenceType.CURRENT_PAGE)

pageReferenceLimit

ParagraphStyle

Long

The page range limit. Can accept: ParagraphStyle or Long. (Optional)

pageNumberStyleOverride

CharacterStyle

The style override for the page number (Optional)

withProperties

Object

Initial values for properties of the new PageReference (Optional)

Number count ()

Displays the number of elements in the PageReference.

Object of

Topic.pageReferences