K4 InDesign Javascript API Documentation

TextFootnotes

A collection of footnotes.

Instance Properties

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

Methods

add(
[at], reference ​[, withProperties])
  → Footnote
anyItem(
)
  → Footnote
count(
)
  → number
everyItem(
)
  → Footnote
firstItem(
)
  → Footnote
item(
index)
  → Footnote
itemByID(
id)
  → Footnote
itemByName(
name)
  → Footnote
itemByRange(
from, to)
  → Footnote
lastItem(
)
  → Footnote
middleItem(
)
  → Footnote
nextItem(
obj)
  → Footnote
previousItem(
obj)
  → Footnote
toSource(
)
  → string
add(
[at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → Footnote
Creates a new footnote.
at LocationOptions The location of the footnote reference number in the main text relative to the reference object or within the story. (Optional)
reference The reference object. Note: Must be an insertion point or a note. Required when the at parameter specifies before or after. Can accept: Note or InsertionPoint. (Optional)
withProperties Object Initial values for properties of the new Footnote (Optional)
anyItem(
)
  → Footnote
Returns any Footnote in the collection.
count(
)
  → number
Displays the number of elements in the Footnote.
everyItem(
)
  → Footnote
Returns every Footnote in the collection.
firstItem(
)
  → Footnote
Returns the first Footnote in the collection.
item(
index)
  → Footnote
Returns the Footnote with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → Footnote
Returns the Footnote with the specified ID.
id number The ID.
itemByName(
name)
  → Footnote
Returns the Footnote with the specified name.
name string The name.
itemByRange(
from, to)
  → Footnote
Returns the Footnotes within the specified range.
from The Footnote, index, or name at the beginning of the range. Can accept: Footnote, Long Integer or String.
to The Footnote, index, or name at the end of the range. Can accept: Footnote, Long Integer or String.
lastItem(
)
  → Footnote
Returns the last Footnote in the collection.
middleItem(
)
  → Footnote
Returns the middle Footnote in the collection.
nextItem(
obj)
  → Footnote
Returns the Footnote whose index follows the specified Footnote in the collection.
obj Footnote The Footnote whose index comes before the desired Footnote.
previousItem(
obj)
  → Footnote
Returns the Footnote with the index previous to the specified index.
obj Footnote The index of the Footnote that follows the desired Footnote.
toSource(
)
  → string
Generates a string which, if executed, will return the Footnote.