Class

PageReferences

 A collection of index page references.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

PageReference [] (index: number)
Returns the PageReference with the specified index.

ParameterTypeDescription
indexnumberThe index.

PageReference add (source: Text[, pageReferenceType: PageReferenceType=PageReferenceType.CURRENT_PAGE][, pageReferenceLimit: varies][, pageNumberStyleOverride: CharacterStyle][, withProperties: Object])
Creates a new page reference.

ParameterTypeDescription
sourceTextThe text or insertion point to which the page reference points.
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
The page number for an index page reference or the last page in an index page reference page range. (Optional) (default: PageReferenceType.CURRENT_PAGE)
pageReferenceLimitLong 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)
pageNumberStyleOverrideCharacterStyleThe style override for the page number. (Optional)
withPropertiesObjectInitial 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: varies)
Returns the PageReference with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

PageReference itemByID (id: number)
Returns the PageReference with the specified ID.

ParameterTypeDescription
idnumberThe ID.

PageReference itemByName (name: string)
Returns the PageReference with the specified name.

ParameterTypeDescription
namestringThe name.

Array of PageReference itemByRange (from: varies, to: varies)
Returns the PageReferences within the specified range.

ParameterTypeDescription
fromLong Integer
PageReference
String
The PageReference, index, or name at the beginning of the range. Can accept: PageReference, Long Integer or String.
toLong 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.

ParameterTypeDescription
objPageReferenceThe PageReference whose index comes before the desired PageReference.

PageReference previousItem (obj: PageReference)
Returns the PageReference with the index previous to the specified index.

ParameterTypeDescription
objPageReferenceThe 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, 28-Apr-2012 v3.0.3hContents :: Index