Footnote

A footnote.

Go to Property Listing | Method Listing

Methods:

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

Property Listing

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	NothingEnum.NOTHING SpecialCharacters SpecialCharacters.AUTO_PAGE_NUMBER SpecialCharacters.NEXT_PAGE_NUMBER SpecialCharacters.PREVIOUS_PAGE_NUMBER SpecialCharacters.SECTION_MARKER SpecialCharacters.BULLET_CHARACTER SpecialCharacters.COPYRIGHT_SYMBOL SpecialCharacters.DEGREE_SYMBOL SpecialCharacters.ELLIPSIS_CHARACTER SpecialCharacters.FORCED_LINE_BREAK SpecialCharacters.PARAGRAPH_SYMBOL SpecialCharacters.REGISTERED_TRADEMARK SpecialCharacters.SECTION_SYMBOL SpecialCharacters.TRADEMARK_SYMBOL SpecialCharacters.RIGHT_INDENT_TAB SpecialCharacters.INDENT_HERE_TAB SpecialCharacters.EM_DASH SpecialCharacters.EN_DASH SpecialCharacters.DISCRETIONARY_HYPHEN SpecialCharacters.NONBREAKING_HYPHEN SpecialCharacters.END_NESTED_STYLE SpecialCharacters.DOUBLE_LEFT_QUOTE SpecialCharacters.DOUBLE_RIGHT_QUOTE SpecialCharacters.SINGLE_LEFT_QUOTE SpecialCharacters.SINGLE_RIGHT_QUOTE SpecialCharacters.EM_SPACE SpecialCharacters.EN_SPACE SpecialCharacters.FLUSH_SPACE SpecialCharacters.HAIR_SPACE SpecialCharacters.NONBREAKING_SPACE SpecialCharacters.THIN_SPACE SpecialCharacters.FIGURE_SPACE SpecialCharacters.PUNCTUATION_SPACE SpecialCharacters.COLUMN_BREAK SpecialCharacters.FRAME_BREAK SpecialCharacters.PAGE_BREAK SpecialCharacters.ODD_PAGE_BREAK SpecialCharacters.EVEN_PAGE_BREAK SpecialCharacters.FOOTNOTE_SYMBOL SpecialCharacters.LEFT_TO_RIGHT_EMBEDDING SpecialCharacters.RIGHT_TO_LEFT_EMBEDDING SpecialCharacters.POP_DIRECTIONAL_FORMATTING SpecialCharacters.LEFT_TO_RIGHT_OVERRIDE SpecialCharacters.RIGHT_TO_LEFT_OVERRIDE SpecialCharacters.DOTTED_CIRCLE SpecialCharacters.ZERO_WIDTH_JOINER SpecialCharacters.TEXT_VARIABLE SpecialCharacters.SINGLE_STRAIGHT_QUOTE SpecialCharacters.DOUBLE_STRAIGHT_QUOTE SpecialCharacters.DISCRETIONARY_LINE_BREAK SpecialCharacters.ZERO_WIDTH_NONJOINER SpecialCharacters.THIRD_SPACE SpecialCharacters.QUARTER_SPACE SpecialCharacters.SIXTH_SPACE SpecialCharacters.FIXED_WIDTH_NONBREAKING_SPACE SpecialCharacters.HEBREW_MAQAF SpecialCharacters.HEBREW_GERESH SpecialCharacters.HEBREW_GERSHAYIM SpecialCharacters.ARABIC_KASHIDA SpecialCharacters.ARABIC_COMMA SpecialCharacters.ARABIC_SEMICOLON SpecialCharacters.ARABIC_QUESTION_MARK SpecialCharacters.LEFT_TO_RIGHT_MARK SpecialCharacters.RIGHT_TO_LEFT_MARK SpecialCharacters.HEBREW_SOF_PASUK String Array of Strings String NothingEnums NothingEnum	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	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	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
lines	Lines Line	readonly	A collection of lines.
name	String	read/write	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	Story TextFrame InsertionPoint XmlStory	readonly	The parent of the Footnote (a XmlStory, Story, TextFrame or InsertionPoint).
polygons	Polygons Polygon	readonly	A collection of polygons.
properties	Object	read/write	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.

Method Listing

EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])

Adds an event listener.

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

Parameter

Type

Description

eventType

String

The event type.

handler

Varies

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

captures

Boolean

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.

Footnote getElements ()

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

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

undefined remove ()

Deletes the Footnote.

Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])

Removes the event listener.

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