Class

Footnotes

 A collection of footnotes.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Footnote [] (index: number)
Returns the Footnote with the specified index.

ParameterTypeDescription
indexnumberThe index.

Footnote add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new footnote.

ParameterTypeDescription
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
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)
referenceInsertionPoint
Note
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)
withPropertiesObjectInitial 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.

Array of Footnote everyItem ()
Returns every Footnote in the collection.

Footnote firstItem ()
Returns the first Footnote in the collection.

Footnote item (index: varies)
Returns the Footnote with the specified index or name.

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

Footnote itemByID (id: number)
Returns the Footnote with the specified ID.

ParameterTypeDescription
idnumberThe ID.

Footnote itemByName (name: string)
Returns the Footnote with the specified name.

ParameterTypeDescription
namestringThe name.

Array of Footnote itemByRange (from: varies, to: varies)
Returns the Footnotes within the specified range.

ParameterTypeDescription
fromFootnote
Long Integer
String
The Footnote, index, or name at the beginning of the range. Can accept: Footnote, Long Integer or String.
toFootnote
Long Integer
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.

ParameterTypeDescription
objFootnoteThe Footnote whose index comes before the desired Footnote.

Footnote previousItem (obj: Footnote)
Returns the Footnote with the index previous to the specified index.

ParameterTypeDescription
objFootnoteThe index of the Footnote that follows the desired Footnote.

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

Element of

Character.footnotes

InsertionPoint.footnotes

Line.footnotes

Paragraph.footnotes

Story.footnotes

Text.footnotes

TextColumn.footnotes

TextFrame.footnotes

TextStyleRange.footnotes

Word.footnotes

XmlStory.footnotes

Jongware, 28-Apr-2012 v3.0.3hContents :: Index