Footnotes

A collection of footnotes.

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

Footnote [] (index:Number)

Returns the Footnote with the specified index.

Parameter

Type

Description

index

Number

The index.

Footnote add ([at:LocationOptions=LocationOptions], reference:Varies Note InsertionPoint, withProperties:Object)

Creates a new footnote.

Parameter

Type

Description

at

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location of the footnote reference number in the main text relative to the reference object or within the story. (Optional)

(default: LocationOptions.UNKNOWN)

reference

Note

InsertionPoint

The reference object. Note: Must be an insertion point or a note. Required when the at parameter specifies before or after. Can accept: Note or InsertionPoint. (Optional)

withProperties

Object

Initial values for properties of the new Footnote (Optional)

Footnote anyItem ()

Returns any Footnote in the collection.

Number count ()

Displays the number of elements in the Footnote.

Footnote everyItem ()

Returns every Footnote in the collection.

Footnote firstItem ()

Returns the first Footnote in the collection.

Footnote item (index:Varies LongInteger String)

Returns the Footnote with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

The index or name. Can accept: Long Integer or String.

Footnote itemByID (id:Number)

Returns the Footnote with the specified ID.

Parameter

Type

Description

id

Number

The ID.

Footnote itemByName (name:String)

Returns the Footnote with the specified name.

Parameter

Type

Description

name

String

The name.

Footnote itemByRange (from:Varies Footnote LongInteger String, to:Varies Footnote LongInteger String)

Returns the Footnotes within the specified range.

Parameter

Type

Description

from

Footnote

LongInteger

String

The Footnote, index, or name at the beginning of the range. Can accept: Footnote, Long Integer or String.

to

Footnote

LongInteger

String

The Footnote, index, or name at the end of the range. Can accept: Footnote, Long Integer or String.

Footnote lastItem ()

Returns the last Footnote in the collection.

Footnote middleItem ()

Returns the middle Footnote in the collection.

Footnote nextItem (obj:Footnote)

Returns the Footnote whose index follows the specified Footnote in the collection.

Parameter

Type

Description

obj

Footnote

The Footnote whose index comes before the desired Footnote.

Footnote previousItem (obj:Footnote)

Returns the Footnote with the index previous to the specified index.

Parameter

Type

Description

obj

Footnote

The index of the Footnote that follows the desired Footnote.

String toSource ()

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

Object of

Cell.footnotes

Table.footnotes

Text.footnotes

Character.footnotes

Word.footnotes

Line.footnotes

TextColumn.footnotes

Paragraph.footnotes

TextStyleRange.footnotes

InsertionPoint.footnotes

TextFrame.footnotes

Story.footnotes

EndnoteTextFrame.footnotes

XmlStory.footnotes