Adobe InDesign CS6 Server (8.0) Object Model JS: Footnote

InDesign Server CS6

previous page next page

Class

Footnote

A footnote.

QuickLinks

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

Hierarchy

InsertionPoint | Story | TextFrame | XmlStory

Footnote

Properties

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

Methods

Instances

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

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This 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.

Parameter	Type	Description
key	string	The 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.

Parameter	Type	Description
key	string	The key.
value	string	The value.

void remove ()
Deletes the Footnote.

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

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)