A footnote in a story.
footnote elements
| Name | Refer to By |
|---|---|
| characters | by numeric index, as a range of elements, before/after another element, satisfying a test |
| graphic lines | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| groups | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| insertion points | by numeric index, as a range of elements, before/after another element, satisfying a test |
| lines | by numeric index, as a range of elements, before/after another element, satisfying a test |
| ovals | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| page items | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| paragraphs | by numeric index, as a range of elements, before/after another element, satisfying a test |
| polygons | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| rectangles | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| text columns | by numeric index, as a range of elements, before/after another element, satisfying a test |
| text frames | by numeric index, by name, as a range of elements, before/after another element, satisfying a test, by ID |
| texts | by numeric index, as a range of elements, before/after another element, satisfying a test |
| text style ranges | by numeric index, as a range of elements, before/after another element, satisfying a test |
| words | by numeric index, as a range of elements, before/after another element, satisfying a test |
footnote properties
| Property | Type | Access | Description |
|---|---|---|---|
| all graphics | list of graphics | read | All graphics contained by the object. |
| all page items | list of page items | read | All page items contained by the object. |
| class | integer | read | The class descriptor type. |
| contents | string, special characters enumeration, list of strings or auto page number/next page number/previous page number/section marker/bullet character/copyright symbol/degree symbol/ellipsis character/forced line break/paragraph symbol/registered trademark/section symbol/trademark symbol/right indent tab/indent here tab/Em dash/En dash/discretionary hyphen/nonbreaking hyphen/end nested style/double left quote/double right quote/single left quote/single right quote/Em space/En space/flush space/hair space/nonbreaking space/thin space/figure space/punctuation space/column break/frame |
r/w | The text contents. |
| footnote text frame | text frame | read | The text frame this footnote appears in. |
| id | integer | read | A unique number identifying the object. |
| index | integer | read | Index of the object within its parent object. |
| label | string | r/w | A label that can be set to any string. |
| object reference | object | read | An object reference for this object. |
| parent | object | read | The parent of the object. |
| properties | record | r/w | Property that allows setting of several properties at the same time. |
| story offset | integer | read | The location of this footnote from the beginning of the story. |
footnote methods
| Method | Returns | Description |
|---|---|---|
| convert to text | text | Convert to text. |
| delete | Nothing | Delete the object. |
| extract label | string | Gets the content of the label associated with the specified key (name). |
| insert label | Nothing | Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |