Class

Footnote

 A footnote.

QuickLinks

addEventListener, convertToText, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier

Hierarchy

InsertionPoint | Story | TextFrame | XmlStory
Footnote
Character | Event | EventListener | HiddenText | InsertionPoint | Line | MutationEvent | Paragraph | Text | TextColumn | TextStyleRange | TextVariableInstance | Word

Properties

PropertyTypeAccessDescription
allGraphicsArray of Graphic readonlyLists all graphics contained by the Footnote.
allPageItemsArray of PageItem readonlyLists all page items contained by the Footnote.
charactersCharacters readonlyA collection of characters.
contentsArray of Strings
Array of Strings
NothingEnum
NothingEnum
SpecialCharacters
SpecialCharacters
SpecialCharacters
String
r/wThe 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.
epstextsEPSTexts readonlyEPSTexts
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
graphicLinesGraphicLines readonlyA collection of graphic lines.
groupsGroups readonlyA collection of groups.
hiddenTextsHiddenTexts readonlyA collection of hidden text objects.
idnumber readonlyThe unique ID of the Footnote.
indexnumber readonlyThe index of the Footnote within its containing object.
insertionPointsInsertionPoints readonlyA collection of insertion points.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
linesLines readonlyA collection of lines.
namestring r/wThe name of the Footnote; this is an alias to the Footnote's label property.
ovalsOvals readonlyA collection of ellipses.
pageItemsPageItems readonlyThe 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.
paragraphsParagraphs readonlyA collection of paragraphs.
parentInsertionPoint
Story
TextFrame
XmlStory
readonlyThe parent of the Footnote (a XmlStory, Story, TextFrame or InsertionPoint).
polygonsPolygons readonlyA collection of polygons.
propertiesObject r/wA property that allows setting of several properties at the same time.
rectanglesRectangles readonlyA collection of rectangles.
splineItemsSplineItems readonlyThe spline items collection.
storyOffsetInsertionPoint readonlyThe location of the footnote marker in the parent story.
textColumnsTextColumns readonlyA collection of text columns.
textFramesTextFrames readonlyA collection of text frames.
textStyleRangesTextStyleRanges readonlyA collection of text style ranges.
textVariableInstancesTextVariableInstances readonlyA collection of text variable instances.
textsTexts readonlyA collection of text objects.
wordsWords readonlyA collection of words.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Footnote getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the Footnote.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

HiddenText.parent

TextVariableInstance.parent

Used in:

Footnote Footnotes.nextItem (obj: Footnote)

Footnote Footnotes.previousItem (obj: Footnote)

Return

Array of Footnote Footnote.getElements ()

Footnote Footnotes.[] (index: number)

Footnote Footnotes.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])

Footnote Footnotes.anyItem ()

Array of Footnote Footnotes.everyItem ()

Footnote Footnotes.firstItem ()

Footnote Footnotes.item (index: varies)

Footnote Footnotes.itemByID (id: number)

Footnote Footnotes.itemByName (name: string)

Array of Footnote Footnotes.itemByRange (from: varies, to: varies)

Footnote Footnotes.lastItem ()

Footnote Footnotes.middleItem ()

Footnote Footnotes.nextItem (obj: Footnote)

Footnote Footnotes.previousItem (obj: Footnote)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index