Footnote

A footnote.

Methods:

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

Objects:

Boolean, Characters, EPSTexts, EventListeners, Events, Graphic, GraphicLines, Groups, HiddenTexts, InsertionPoints, Lines, Number, Object, Ovals, PageItem, PageItems, Paragraphs, Polygons, Rectangles, SpecialCharacters, SplineItems, String, TextColumns, TextFrames, TextStyleRanges, TextVariableInstances, Texts, TypefiElementAnchors, Words,

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

SpecialCharacters

SpecialCharacters.ARABIC_COMMA

SpecialCharacters.ARABIC_KASHIDA

SpecialCharacters.ARABIC_QUESTION_MARK

SpecialCharacters.ARABIC_SEMICOLON

SpecialCharacters.AUTO_PAGE_NUMBER

SpecialCharacters.BULLET_CHARACTER

SpecialCharacters.COLUMN_BREAK

SpecialCharacters.COPYRIGHT_SYMBOL

SpecialCharacters.DEGREE_SYMBOL

SpecialCharacters.DISCRETIONARY_HYPHEN

SpecialCharacters.DISCRETIONARY_LINE_BREAK

SpecialCharacters.DOTTED_CIRCLE

SpecialCharacters.DOUBLE_LEFT_QUOTE

SpecialCharacters.DOUBLE_RIGHT_QUOTE

SpecialCharacters.DOUBLE_STRAIGHT_QUOTE

SpecialCharacters.ELLIPSIS_CHARACTER

SpecialCharacters.EM_DASH

SpecialCharacters.EM_SPACE

SpecialCharacters.END_NESTED_STYLE

SpecialCharacters.EN_DASH

SpecialCharacters.EN_SPACE

SpecialCharacters.EVEN_PAGE_BREAK

SpecialCharacters.FIGURE_SPACE

SpecialCharacters.FIXED_WIDTH_NONBREAKING_SPACE

SpecialCharacters.FLUSH_SPACE

SpecialCharacters.FOOTNOTE_SYMBOL

SpecialCharacters.FORCED_LINE_BREAK

SpecialCharacters.FRAME_BREAK

SpecialCharacters.HAIR_SPACE

SpecialCharacters.HEBREW_GERESH

SpecialCharacters.HEBREW_GERSHAYIM

SpecialCharacters.HEBREW_MAQAF

SpecialCharacters.HEBREW_SOF_PASUK

SpecialCharacters.INDENT_HERE_TAB

SpecialCharacters.LEFT_TO_RIGHT_EMBEDDING

SpecialCharacters.LEFT_TO_RIGHT_MARK

SpecialCharacters.LEFT_TO_RIGHT_OVERRIDE

SpecialCharacters.NEXT_PAGE_NUMBER

SpecialCharacters.NONBREAKING_HYPHEN

SpecialCharacters.NONBREAKING_SPACE

SpecialCharacters.ODD_PAGE_BREAK

SpecialCharacters.PAGE_BREAK

SpecialCharacters.PARAGRAPH_SYMBOL

SpecialCharacters.POP_DIRECTIONAL_FORMATTING

SpecialCharacters.PREVIOUS_PAGE_NUMBER

SpecialCharacters.PUNCTUATION_SPACE

SpecialCharacters.QUARTER_SPACE

SpecialCharacters.REGISTERED_TRADEMARK

SpecialCharacters.RIGHT_INDENT_TAB

SpecialCharacters.RIGHT_TO_LEFT_EMBEDDING

SpecialCharacters.RIGHT_TO_LEFT_MARK

SpecialCharacters.RIGHT_TO_LEFT_OVERRIDE

SpecialCharacters.SECTION_MARKER

SpecialCharacters.SECTION_SYMBOL

SpecialCharacters.SINGLE_LEFT_QUOTE

SpecialCharacters.SINGLE_RIGHT_QUOTE

SpecialCharacters.SINGLE_STRAIGHT_QUOTE

SpecialCharacters.SIXTH_SPACE

SpecialCharacters.TEXT_VARIABLE

SpecialCharacters.THIN_SPACE

SpecialCharacters.THIRD_SPACE

SpecialCharacters.TRADEMARK_SYMBOL

SpecialCharacters.ZERO_WIDTH_JOINER

SpecialCharacters.ZERO_WIDTH_NONJOINER

String

Array of Strings String

NothingEnums NothingEnum

SpecialCharactersCanalsoaccept: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

EndnoteTextFrame

Story

TextFrame

InsertionPoint

XmlStory

readonly

The parent of the Footnote (a XmlStory, Story, TextFrame, EndnoteTextFrame 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.

typefiElementAnchors

TypefiElementAnchors TypefiElementAnchor

readonly

A list of Typefi element anchors

words

Words Word

readonly

A collection of words.

Method Listing

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

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

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 File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

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. (Optional)

(default: false)

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Character.parent

Event.parent

EventListener.parent

HiddenText.parent

InsertionPoint.parent

Line.parent

MutationEvent.parent

Paragraph.parent

Text.parent

TextColumn.parent

TextStyleRange.parent

TextVariableInstance.parent

TypefiElementAnchor.parent

Word.parent

Return

Footnotes.add()

Footnote.getElements()

Footnotes.anyItem()

Footnotes.everyItem()

Footnotes.nextItem()

Footnotes.previousItem()

Footnotes.itemByID()

Footnotes.item()

Footnotes.[]()

Footnotes.itemByName()

Footnotes.itemByRange()

Footnotes.firstItem()

Footnotes.lastItem()

Footnotes.middleItem()