K4 InDesign Javascript API Documentation

TextEndnotes

A collection of endnotes.

Instance Properties

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

Methods

anyItem(
)
  → Endnote
count(
)
  → number
everyItem(
)
  → Endnote
firstItem(
)
  → Endnote
item(
index)
  → Endnote
itemByID(
id)
  → Endnote
itemByName(
name)
  → Endnote
itemByRange(
from, to)
  → Endnote
lastItem(
)
  → Endnote
middleItem(
)
  → Endnote
nextItem(
obj)
  → Endnote
previousItem(
obj)
  → Endnote
toSource(
)
  → string
anyItem(
)
  → Endnote
Returns any Endnote in the collection.
count(
)
  → number
Displays the number of elements in the Endnote.
everyItem(
)
  → Endnote
Returns every Endnote in the collection.
firstItem(
)
  → Endnote
Returns the first Endnote in the collection.
item(
index)
  → Endnote
Returns the Endnote with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → Endnote
Returns the Endnote with the specified ID.
id number The ID.
itemByName(
name)
  → Endnote
Returns the Endnote with the specified name.
name string The name.
itemByRange(
from, to)
  → Endnote
Returns the Endnotes within the specified range.
from The Endnote, index, or name at the beginning of the range. Can accept: Endnote, Long Integer or String.
to The Endnote, index, or name at the end of the range. Can accept: Endnote, Long Integer or String.
lastItem(
)
  → Endnote
Returns the last Endnote in the collection.
middleItem(
)
  → Endnote
Returns the middle Endnote in the collection.
nextItem(
obj)
  → Endnote
Returns the Endnote whose index follows the specified Endnote in the collection.
obj Endnote The Endnote whose index comes before the desired Endnote.
previousItem(
obj)
  → Endnote
Returns the Endnote with the index previous to the specified index.
obj Endnote The index of the Endnote that follows the desired Endnote.
toSource(
)
  → string
Generates a string which, if executed, will return the Endnote.