Object

Footnote

A footnote.

Hierarchy

Footnote

Properties

Type	Access	Description
Graphic[]	readonly	Lists all graphics contained by the Footnote.
PageItem[]	readonly	Lists all page items contained by the Footnote.
Characters<Character>	readonly	A collection of characters.
NothingEnum[] \| SpecialCharacters[] \| SpecialCharacters[] \| String[] \| Strings[] \| Strings[] \| NothingEnums[] \| SpecialCharacters[]	read/write	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.
EPSTexts<EPSText>	readonly	EPSTexts
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
GraphicLines<GraphicLine>	readonly	A collection of graphic lines.
Groups<Group>	readonly	A collection of groups.
HiddenTexts<HiddenText>	readonly	A collection of hidden text objects.
Number	readonly	The unique ID of the Footnote.
Number	readonly	The index of the Footnote within its containing object.
InsertionPoints<InsertionPoint>	readonly	A collection of insertion points.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
String	read/write	A property that can be set to any string.
Lines<Line>	readonly	A collection of lines.
String	read/write	The name of the Footnote; this is an alias to the Footnote's label property.
Ovals<Oval>	readonly	A collection of ellipses.
PageItems<PageItem>	readonly	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.
Paragraphs<Paragraph>	readonly	A collection of paragraphs.
Cell \| EndnoteTextFrame \| Story \| TextFrame \| InsertionPoint \| XmlStory	readonly	The parent of the Footnote (a XmlStory, Cell, Story, TextFrame, EndnoteTextFrame or InsertionPoint).
Polygons<Polygon>	readonly	A collection of polygons.
Object	read/write	A property that allows setting of several properties at the same time.
Rectangles<Rectangle>	readonly	A collection of rectangles.
SplineItems<SplineItem>	readonly	The spline items collection.
InsertionPoint	readonly	The location of the footnote marker in the parent story.
TextColumns<TextColumn>	readonly	A collection of text columns.
TextFrames<TextFrame>	readonly	A collection of text frames.
TextStyleRanges<TextStyleRange>	readonly	A collection of text style ranges.
TextVariableInstances<TextVariableInstance>	readonly	A collection of text variable instances.
Texts<Text>	readonly	A collection of text objects.
Words<Word>	readonly	A collection of words.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.

handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ 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.

→ String

Gets the label value associated with the specified key.

key String The key.

→ Footnote[]

Resolves the object specifier, creating an array of object references.

→ void

Sets the label to the value associated with the specified key.

key String The key.

value String The value.

→ void

Deletes the Footnote.

→ Boolean

Removes the event listener.

eventType String The registered event type.

handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ String

Generates a string which, if executed, will return the Footnote.

→ String

Retrieves the object specifier.

Object of 13

Properties elsewhere that hold a Footnote.

Character.parent Event.parent EventListener.parent HiddenText.parent InsertionPoint.parent Line.parent MutationEvent.parent Paragraph.parent Text.parent TextColumn.parent TextStyleRange.parent TextVariableInstance.parent Word.parent

Parameter of 4

Method parameters that accept a Footnote.

Footnotes.itemByRange(from)Footnotes.nextItem(obj)Footnotes.previousItem(obj)TextVariableInstances.add(reference)

Return 14

Methods that return a Footnote.

Footnote.getElements()Footnotes.[]()Footnotes.add()Footnotes.anyItem()Footnotes.everyItem()Footnotes.firstItem()Footnotes.item()Footnotes.itemByID()Footnotes.itemByName()Footnotes.itemByRange()Footnotes.lastItem()Footnotes.middleItem()Footnotes.nextItem()Footnotes.previousItem()