Footnotes
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
Footnote [] (index:
number)
Returns the Footnote with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
Footnote add ([at:
LocationOptions=LocationOptions.UNKNOWN][, reference:
any][, withProperties:
Object])
Creates a new footnote.
| Parameter | Type | Description |
|---|---|---|
| at | LocationOptions: 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) |
| reference | InsertionPoint 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) |
| 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.
Array of Footnote everyItem ()
Returns every Footnote in the collection.
Footnote firstItem ()
Returns the first Footnote in the collection.
Footnote item (index:
any)
Returns the Footnote with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer 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. |
Array of Footnote itemByRange (from:
any, to:
any)
Returns the Footnotes within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Footnote Long Integer String | The Footnote, index, or name at the beginning of the range. Can accept: Footnote, Long Integer or String. |
| to | Footnote 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.
| 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.
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, 20-Jun-2010 v3.0.3d | Contents :: Index |