K4 InDesign Javascript API Documentation

TextFootnote

A footnote.

Instance Properties

Name Description Access
allGraphics Graphic Lists all graphics contained by the Footnote. read-only
allPageItems PageItem Lists all page items contained by the Footnote. read-only
characters Characters A collection of characters. read-only
contents The text contents of the footnote. Can return: String, SpecialCharacters enumerator or Array of Strings or SpecialCharacters enumerators. Can also accept: NothingEnum enumerator or Array of Strings, SpecialCharacters enumerators or NothingEnum enumerators. read-write
epstexts EPSTexts EPSTexts read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
graphicLines GraphicLines A collection of graphic lines. read-only
groups Groups A collection of groups. read-only
hiddenTexts HiddenTexts A collection of hidden text objects. read-only
id number The unique ID of the Footnote. read-only
index number The index of the Footnote within its containing object. read-only
insertionPoints InsertionPoints A collection of insertion points. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
lines Lines A collection of lines. read-only
name string The name of the Footnote; this is an alias to the Footnote's label property. read-write
ovals Ovals A collection of ellipses. read-only
pageItems PageItems The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type. read-only
paragraphs Paragraphs A collection of paragraphs. read-only
parent The parent of the Footnote (a XmlStory, Story, TextFrame, EndnoteTextFrame or InsertionPoint). read-only
polygons Polygons A collection of polygons. read-only
properties Object A property that allows setting of several properties at the same time. read-write
rectangles Rectangles A collection of rectangles. read-only
splineItems SplineItems The spline items collection. read-only
storyOffset InsertionPoint The location of the footnote marker in the parent story. read-only
textColumns TextColumns A collection of text columns. read-only
textFrames TextFrames A collection of text frames. read-only
textStyleRanges TextStyleRanges A collection of text style ranges. read-only
textVariableInstances TextVariableInstances A collection of text variable instances. read-only
texts Texts A collection of text objects. read-only
words Words A collection of words. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
convertToText(
)
  → Text
extractLabel(
key)
  → string
getElements(
)
  → Footnote
insertLabel(
key, value)
remove(
)
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
convertToText(
)
  → Text
Converts the footnote to part of the story text and places the converted text at the former location of the footnote marker in the text.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → Footnote
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
remove(
)
Deletes the Footnote.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the Footnote.
toSpecifier(
)
  → string
Retrieves the object specifier.