K4 InDesign Javascript API Documentation

TextEndnoteTextFrames

A collection of endnote text frames.

Instance Properties

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

Methods

add(
[layer] ​[, at], reference ​[, withProperties])
  → EndnoteTextFrame
anyItem(
)
  → EndnoteTextFrame
count(
)
  → number
everyItem(
)
  → EndnoteTextFrame
firstItem(
)
  → EndnoteTextFrame
item(
index)
  → EndnoteTextFrame
itemByID(
id)
  → EndnoteTextFrame
itemByName(
name)
  → EndnoteTextFrame
itemByRange(
from, to)
  → EndnoteTextFrame
lastItem(
)
  → EndnoteTextFrame
middleItem(
)
  → EndnoteTextFrame
nextItem(
obj)
  → EndnoteTextFrame
previousItem(
obj)
  → EndnoteTextFrame
toSource(
)
  → string
add(
[layer] ​[, at=LocationOptions.UNKNOWN], reference ​[, withProperties])
  → EndnoteTextFrame
Creates a new EndnoteTextFrame
layer Layer The layer on which to create the EndnoteTextFrame. (Optional)
at LocationOptions The location at which to insert the EndnoteTextFrame relative to the reference object or within the container object. (Optional)
reference The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withProperties Object Initial values for properties of the new EndnoteTextFrame (Optional)
anyItem(
)
  → EndnoteTextFrame
Returns any EndnoteTextFrame in the collection.
count(
)
  → number
Displays the number of elements in the EndnoteTextFrame.
everyItem(
)
  → EndnoteTextFrame
Returns every EndnoteTextFrame in the collection.
firstItem(
)
  → EndnoteTextFrame
Returns the first EndnoteTextFrame in the collection.
item(
index)
  → EndnoteTextFrame
Returns the EndnoteTextFrame with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
  → EndnoteTextFrame
Returns the EndnoteTextFrame with the specified ID.
id number The ID.
itemByName(
name)
  → EndnoteTextFrame
Returns the EndnoteTextFrame with the specified name.
name string The name.
itemByRange(
from, to)
  → EndnoteTextFrame
Returns the EndnoteTextFrames within the specified range.
from The EndnoteTextFrame, index, or name at the beginning of the range. Can accept: EndnoteTextFrame, Long Integer or String.
to The EndnoteTextFrame, index, or name at the end of the range. Can accept: EndnoteTextFrame, Long Integer or String.
lastItem(
)
  → EndnoteTextFrame
Returns the last EndnoteTextFrame in the collection.
middleItem(
)
  → EndnoteTextFrame
Returns the middle EndnoteTextFrame in the collection.
nextItem(
obj)
  → EndnoteTextFrame
Returns the EndnoteTextFrame whose index follows the specified EndnoteTextFrame in the collection.
obj EndnoteTextFrame The EndnoteTextFrame whose index comes before the desired EndnoteTextFrame.
previousItem(
obj)
  → EndnoteTextFrame
Returns the EndnoteTextFrame with the index previous to the specified index.
obj EndnoteTextFrame The index of the EndnoteTextFrame that follows the desired EndnoteTextFrame.
toSource(
)
  → string
Generates a string which, if executed, will return the EndnoteTextFrame.