Footnote

A footnote.

Methods:

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

Objects:

Characters.html#d1e157876, Graphic.html#d1e106094, GraphicLines.html#d1e91741, Groups.html#d1e97082, InsertionPoints.html#d1e179016, Lines.html#d1e164923, Number, Object, Ovals.html#d1e86383, PageItem.html#d1e81461, PageItems.html#d1e83775, Paragraphs.html#d1e171970, Polygons.html#d1e94430, Rectangles.html#d1e89072, SpecialCharacters.html#d1e39826, String, TextColumns.html#d1e168446, TextFrame.html#d1e179279, TextFrames.html#d1e181922, TextStyleRanges.html#d1e175493, Texts.html#d1e154353, Words.html#d1e161400

Property Listing

Property

Type

Access

Description

allGraphics

Array of Graphic.html#d1e106094

readonly

Lists all graphics contained by the Footnote.

allPageItems

Array of PageItem.html#d1e81461

readonly

Lists all page items contained by the Footnote.

characters

Characters.html#d1e157876 Character.html#d1e154615

readonly

A collection of characters.

contents

SpecialCharacters.html#d1e39826

SpecialCharacters.AUTO_PAGE_NUMBER

SpecialCharacters.BULLET_CHARACTER

SpecialCharacters.COLUMN_BREAK

SpecialCharacters.COPYRIGHT_SYMBOL

SpecialCharacters.DEGREE_SYMBOL

SpecialCharacters.DISCRETIONARY_HYPHEN

SpecialCharacters.DOUBLE_LEFT_QUOTE

SpecialCharacters.DOUBLE_RIGHT_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.FLUSH_SPACE

SpecialCharacters.FOOTNOTE_SYMBOL

SpecialCharacters.FORCED_LINE_BREAK

SpecialCharacters.FRAME_BREAK

SpecialCharacters.HAIR_SPACE

SpecialCharacters.INDENT_HERE_TAB

SpecialCharacters.NEXT_PAGE_NUMBER

SpecialCharacters.NONBREAKING_HYPHEN

SpecialCharacters.NONBREAKING_SPACE

SpecialCharacters.ODD_PAGE_BREAK

SpecialCharacters.PAGE_BREAK

SpecialCharacters.PARAGRAPH_SYMBOL

SpecialCharacters.PREVIOUS_PAGE_NUMBER

SpecialCharacters.PUNCTUATION_SPACE

SpecialCharacters.REGISTERED_TRADEMARK

SpecialCharacters.RIGHT_INDENT_TAB

SpecialCharacters.SECTION_MARKER

SpecialCharacters.SECTION_SYMBOL

SpecialCharacters.SINGLE_LEFT_QUOTE

SpecialCharacters.SINGLE_RIGHT_QUOTE

SpecialCharacters.THIN_SPACE

SpecialCharacters.TRADEMARK_SYMBOL

String

Array of Strings String

NothingEnums NothingEnum.html#d1e43981

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.

footnoteTextFrame

TextFrame.html#d1e179279

readonly

The text frame this footnote appears in.

graphicLines

GraphicLines.html#d1e91741 GraphicLine.html#d1e89439

readonly

A collection of graphic lines.

groups

Groups.html#d1e97082 Group.html#d1e94825

readonly

A collection of groups.

id

Number

readonly

The unique ID of the Footnote.

index

Number

readonly

The index of the Footnote within its containing object.

insertionPoints

InsertionPoints.html#d1e179016 InsertionPoint.html#d1e175755

readonly

A collection of insertion points.

label

String

read/write

A property that can be set to any string.

lines

Lines.html#d1e164923 Line.html#d1e161662

readonly

A collection of lines.

ovals

Ovals.html#d1e86383 Oval.html#d1e84060

readonly

A collection of ellipses.

pageItems

PageItems.html#d1e83775 PageItem.html#d1e81461

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.html#d1e171970 Paragraph.html#d1e168709

readonly

A collection of paragraphs.

parent

InsertionPoint.html#d1e175755

Line.html#d1e161662

Paragraph.html#d1e168709

Text.html#d1e151095

TextColumn.html#d1e165185

TextFrame.html#d1e179279

TextStyleRange.html#d1e172232

Word.html#d1e158139

Character.html#d1e154615

Story.html#d1e182288

readonly

The parent of the Footnote (a Story, TextFrame, InsertionPoint, TextColumn, TextStyleRange, Text, Paragraph, Line, Word or Character).

polygons

Polygons.html#d1e94430 Polygon.html#d1e92107

readonly

A collection of polygons.

properties

Object

read/write

A property that allows setting of several properties at the same time.

rectangles

Rectangles.html#d1e89072 Rectangle.html#d1e86749

readonly

A collection of rectangles.

storyOffset

Number

readonly

The location of this footnote from the beginning of the story.

textColumns

TextColumns.html#d1e168446 TextColumn.html#d1e165185

readonly

A collection of text columns.

textFrames

TextFrames.html#d1e181922 TextFrame.html#d1e179279

readonly

A collection of text frames.

textStyleRanges

TextStyleRanges.html#d1e175493 TextStyleRange.html#d1e172232

readonly

A collection of text style ranges.

texts

Texts.html#d1e154353 Text.html#d1e151095

readonly

A collection of text objects.

words

Words.html#d1e161400 Word.html#d1e158139

readonly

A collection of words.

Method Listing

Text.html#d1e151095 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.

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

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

Character.html#d1e154615.parent

GraphicLine.html#d1e89439.parent

Group.html#d1e94825.parent

InsertionPoint.html#d1e175755.parent

Line.html#d1e161662.parent

Oval.html#d1e84060.parent

PageItem.html#d1e81461.parent

Paragraph.html#d1e168709.parent

Polygon.html#d1e92107.parent

Rectangle.html#d1e86749.parent

Text.html#d1e151095.parent

TextColumn.html#d1e165185.parent

TextFrame.html#d1e179279.parent

TextStyleRange.html#d1e172232.parent

Word.html#d1e158139.parent

Return

Footnotes.add()

Footnotes.anyItem()

Footnotes.everyItem()

Footnotes.nextItem()

Footnotes.previousItem()

Footnotes.itemByID()

Footnotes.item()

Footnotes.itemByName()

Footnotes.itemByRange()

Footnotes.firstItem()

Footnotes.lastItem()

Footnotes.middleItem()