K4 InDesign Javascript API Documentation

IndexingPageReferences

A collection of index page references.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
source ​[, pageReferenceType], pageReferenceLimit ​[, pageNumberStyleOverride] ​[, withProperties])
  → PageReference
anyItem(
)
  → PageReference
count(
)
  → number
everyItem(
)
  → PageReference
firstItem(
)
  → PageReference
item(
index)
  → PageReference
itemByID(
id)
  → PageReference
itemByName(
name)
  → PageReference
itemByRange(
from, to)
  → PageReference
lastItem(
)
  → PageReference
middleItem(
)
  → PageReference
nextItem(
obj)
  → PageReference
previousItem(
obj)
  → PageReference
toSource(
)
  → string
add(
source ​[, pageReferenceType=PageReferenceType.CURRENT_PAGE], pageReferenceLimit ​[, pageNumberStyleOverride] ​[, withProperties])
  → PageReference
Creates a new page reference.
source Text The text or insertion point to which the page reference points.
pageReferenceType PageReferenceType The page number for an index page reference or the last page in an index page reference page range. (Optional)
pageReferenceLimit 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)
pageNumberStyleOverride CharacterStyle The style override for the page number. (Optional)
withProperties Object Initial values for properties of the new PageReference (Optional)
anyItem(
)
  → PageReference
Returns any PageReference in the collection.
count(
)
  → number
Displays the number of elements in the PageReference.
everyItem(
)
  → PageReference
Returns every PageReference in the collection.
firstItem(
)
  → PageReference
Returns the first PageReference in the collection.
item(
index)
  → PageReference
Returns the PageReference with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → PageReference
Returns the PageReference with the specified ID.
id number The ID.
itemByName(
name)
  → PageReference
Returns the PageReference with the specified name.
name string The name.
itemByRange(
from, to)
  → PageReference
Returns the PageReferences within the specified range.
from The PageReference, index, or name at the beginning of the range. Can accept: PageReference, Long Integer or String.
to The PageReference, index, or name at the end of the range. Can accept: PageReference, Long Integer or String.
lastItem(
)
  → PageReference
Returns the last PageReference in the collection.
middleItem(
)
  → PageReference
Returns the middle PageReference in the collection.
nextItem(
obj)
  → PageReference
Returns the PageReference whose index follows the specified PageReference in the collection.
obj PageReference The PageReference whose index comes before the desired PageReference.
previousItem(
obj)
  → PageReference
Returns the PageReference with the index previous to the specified index.
obj PageReference The index of the PageReference that follows the desired PageReference.
toSource(
)
  → string
Generates a string which, if executed, will return the PageReference.