Footnote
QuickLinks
Hierarchy
Properties
| 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 | readonly | A collection of characters. |
| contents | Array of Strings Array of Strings NothingEnum NothingEnum SpecialCharacters SpecialCharacters SpecialCharacters String |
r/w | 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. |
| graphicLines | GraphicLines | readonly | A collection of graphic lines. |
| groups | Groups | readonly | A collection of groups. |
| hiddenTexts | HiddenTexts | 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 | readonly | A collection of insertion points. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| lines | Lines | readonly | A collection of lines. |
| ovals | Ovals | readonly | A collection of ellipses. |
| pageItems | PageItems | 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 | readonly | A collection of paragraphs. |
| parent | InsertionPoint Story TextFrame XmlStory |
readonly | The parent of the Footnote (a XmlStory, Story, TextFrame or InsertionPoint). |
| polygons | Polygons | readonly | A collection of polygons. |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| rectangles | Rectangles | readonly | A collection of rectangles. |
| storyOffset | InsertionPoint | readonly | The location of the footnote marker in the parent story. |
| textColumns | TextColumns | readonly | A collection of text columns. |
| textFrames | TextFrames | readonly | A collection of text frames. |
| textStyleRanges | TextStyleRanges | readonly | A collection of text style ranges. |
| textVariableInstances | TextVariableInstances | readonly | A collection of text variable instances. |
| texts | Texts | readonly | A collection of text objects. |
| words | Words | readonly | A collection of words. |
Methods
Instances
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. |
Array of Footnote getElements ()
Resolves the object specifier, creating an array of object references.
void 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. |
void remove ()
Deletes the Footnote.
string toSource ()
Generates a string which, if executed, will return the Footnote.
string toSpecifier ()
Retrieves the object specifier.
Element of
HiddenText.parent
PageItem.parent
TextVariableInstance.parent
Used in:
array of Footnote Footnotes.itemByRange (from: any, to: any)
Footnote Footnotes.nextItem (obj: Footnote)
Footnote Footnotes.previousItem (obj: Footnote)
TextVariableInstance TextVariableInstances.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Return
Array of Footnote Footnote.getElements ()
Footnote Footnotes.[] (index: number)
Footnote Footnotes.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Footnote Footnotes.anyItem ()
Array of Footnote Footnotes.everyItem ()
Footnote Footnotes.firstItem ()
Footnote Footnotes.item (index: any)
Footnote Footnotes.itemByID (id: number)
Footnote Footnotes.itemByName (name: string)
Array of Footnote Footnotes.itemByRange (from: any, to: any)
Footnote Footnotes.lastItem ()
Footnote Footnotes.middleItem ()
Footnote Footnotes.nextItem (obj: Footnote)
Footnote Footnotes.previousItem (obj: Footnote)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |