Footnote
A footnote.
Instance
Read Only
InsertionPoint storyOffset
The location of the footnote marker in the parent story.
Read Only
PageItem allPageItems
Lists all page items contained by the Footnote.
Read Only
Graphic allGraphics
Lists all graphics contained by the Footnote.
Read Only
Number id
The unique ID of the Footnote.
Read Only
Boolean isValid
Returns true if the object specifier resolves to valid objects.
Read Only
Mixed parent
The parent of the Footnote (a XmlStory, Cell, Story, TextFrame, EndnoteTextFrame or InsertionPoint).
Read Only
Number index
The index of the Footnote within its containing object.
Read Only
TextColumns textColumns
A collection of text columns.
Read Only
Texts texts
A collection of text objects.
Read Only
TextStyleRanges textStyleRanges
A collection of text style ranges.
Read Only
Paragraphs paragraphs
A collection of paragraphs.
Read Only
Lines lines
A collection of lines.
Read Only
Words words
A collection of words.
Read Only
Characters characters
A collection of characters.
Read Only
InsertionPoints insertionPoints
A collection of insertion points.
Read Only
TextVariableInstances textVariableInstances
A collection of text variable instances.
Read Only
Ovals ovals
A collection of ellipses.
Read Only
SplineItems splineItems
The spline items collection.
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
Rectangles rectangles
A collection of rectangles.
Read Only
GraphicLines graphicLines
A collection of graphic lines.
Read Only
TextFrames textFrames
A collection of text frames.
Read Only
Polygons polygons
A collection of polygons.
Read Only
Events events
A collection of events.
Read Only
EventListeners eventListeners
A collection of event listeners.
Read Only
Groups groups
A collection of groups.
Read Only
EPSTexts epstexts
EPSTexts
Read Only
HiddenTexts hiddenTexts
A collection of hidden text objects.
Mixed 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.
String label
A property that can be set to any string.
String name
The name of the Footnote; this is an alias to the Footnote's label property.
Object properties
A property that allows setting of several properties at the same time.
Methods
remove()
Deletes the Footnote.
Text convertToText()
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.
insertLabel( String key, String value )
Sets the label to the value associated with the specified key.
Parameters
Type Name Description
String extractLabel( String key )
Gets the label value associated with the specified key.
Parameters
Type Name Description
String toSource()
Generates a string which, if executed, will return the Footnote.
Footnote getElements()
Resolves the object specifier, creating an array of object references.
String toSpecifier()
Retrieves the object specifier.
EventListener addEventListener( String eventType, Mixed handler, Boolean captures )
Adds an event listener.
Parameters
Type Name Description
Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )
Removes the event listener.
Parameters
Type Name Description