Adds an event listener.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the rule above continued footnote text. Note: Valid when continuing rule on is true. Can return: Swatch or String. | |
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the rule above continued footnote text. Note: Valid when continuing rule type is not solid. Can return: Swatch or String. | |
| Boolean | read/write | If true, overprints the gap color of the rule above continued footnote text. Note: Valid when continuing rule type is not solid. | |
| Number 0–100 | read/write | The tint (as a percentage) of the gap color of the rule above continued footnote text. (Range: 0 to 100) Note: Valid when continuing rule type is not solid. | |
| Number | String unit | read/write | The amount to left indent the rule above continued footnote text. Note: Valid when continuing rule on is true. | |
| Number | String unit | read/write | The stroke weight of the rule above continued footnote text. (Range: 0 to 1000) Note: Valid when continuing rule on is true. | |
| Number | String unit | read/write | The vertical offset of the rule above continued footnote text. Note: Valid when continuing rule on is true. | |
| Boolean | read/write | If true, draws a rule above footnote text that continues from a previous column. Note: Valid when no splitting is false or undefined. | |
| Boolean | read/write | If true, overprints the rule above continued footnote text. Note: Valid when continuing rule on is true. | |
| Number 0–100 | read/write | The tint (as a percentage) of the rule above continued footnote text. (Range: 0 to 100) Note: Valid when continuing rule type is not solid. | |
| StrokeStyle | String | read/write | The stroke type of the rule above continued footnote text. Note: Valid when continuing rule on is true. Can return: StrokeStyle or String. | |
| Number | String unit | read/write | The length of the rule above continued footnote text. Note: Valid when continuing rule on is true. | |
| Boolean | read/write | If true, document will have straddling footnotes. If false, document will not have straddling footnotes. | |
| Boolean | read/write | If true, footnotes at the end of the story are placed just below the text. If false, footnotes at the end of the story are placed at the bottom of the column. | |
| EventListeners |
readonly | A collection of event listeners. | |
| Events |
readonly | A collection of events. | |
| FootnoteFirstBaseline | read/write | The distance between the top of the footnote container and the footnote text. | |
| CharacterStyle | read/write | The character style to apply to footnote reference numbers in the main text. | |
| Number | String unit | read/write | The minimum distance between the baseline of the text and the top of the footnote container. | |
| FootnoteNumberingStyle | String | read/write | The footnote numbering style. Can return: FootnoteNumberingStyle enumerator or String. | |
| ParagraphStyle | read/write | The paragraph style to apply to footnotes. Note: The space before and after the paragraph defined in the paragraph style is ignored for footnotes. To define space above and between footnotes, see spacer and space between. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| FootnoteMarkerPositioning | String | read/write | The position of footnote reference numbers in the main text. Can return: FootnoteMarkerPositioning enumerator or String. | |
| Boolean | read/write | If true, footnotes cannot split across columns. If false, footnotes flow into succeeding columns when the footnote text causes the footnote area to expand upward to reach the footnote reference number in the main text. | |
| Application | Document | readonly | The parent of the FootnoteOption (a Application or Document). | |
| String | read/write | The prefix text of the footnote. (Limit: 0 to 100 characters) | |
| Object | read/write | A property that allows setting of several properties at the same time. | |
| FootnoteRestarting | String | read/write | The point at which to restart footnote numbering. Can return: FootnoteRestarting enumerator or String. | |
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the rule above the first footnote in the column. Note: Valid when rule on is true. Can return: Swatch or String. | |
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the stroke gap of the rule above the first footnote in the column. Note: Valid when rule type is not solid. Can return: Swatch or String. | |
| Boolean | read/write | If true, overprints the gap color of the rule above the first footnote in the column. Note: Valid when rule type is not solid. | |
| Number 0–100 | read/write | The tint (as a percentage) of the gap color of the rule above the first footnote in the column. (Range: 0 to 100) Note: Valid when rule type is not solid. | |
| Number | String unit | read/write | The amount to left indent the rule above the first footnote in the column. Note: Valid when rule on is true. | |
| Number | String unit | read/write | The stroke weight of the rule above the first footnote in the column. (Range: 0 to 1000) Note: Valid when rule on is true. | |
| Number | String unit | read/write | The vertical offset of the rule above the first footnote in the column. Note: Valid when rule on is true. | |
| Boolean | read/write | If true, draws a rule between the text and the first footnote in the column. | |
| Boolean | read/write | If true, overprints the rule above the first footnote in the column. Note: Valid when rule on is true. | |
| Number 0–100 | read/write | The tint (as a percentage) of the rule above the first footnote in the column. (Range: 0 to 100) Note: Valid when rule on is true. | |
| StrokeStyle | String | read/write | The stroke type of the rule above the first footnote in a column. Note: Valid when rule on is true. Can return: StrokeStyle or String. | |
| Number | String unit | read/write | The length of the rule above the first footnote in the column. Note: Valid when rule on is true. | |
| String 0–100 | read/write | The text to insert between the footnote marker number and the footnote text. (Range: 0 to 100 characters) | |
| FootnotePrefixSuffix | String | read/write | The position of the footnote prefix and/or suffix. Can return: FootnotePrefixSuffix enumerator or String. | |
| Number | String unit | read/write | The amount of vertical space between footnotes. Note: The space before and space after defined for the paragraph style applied to the footnote is ignored. | |
| Number | String unit | read/write | The minimum amount of vertical space between the bottom of the text column and the first footnote. Note: The space before amount defined in the paragraph style applied to the footnote is ignored for the first footnote. | |
| Number 1–100000 | read/write | The number at which to start footnote numbering. | |
| String | read/write | The suffix text of the footnote. (Limit: 0 to 100 characters) |
Methods
→ FootnoteOption[]
Resolves the object specifier, creating an array of object references.
→ Boolean
Removes the event listener.
→ String
Generates a string which, if executed, will return the FootnoteOption.
→ String
Retrieves the object specifier.
Object of 5
Properties elsewhere that hold a FootnoteOption.
Return 1
Methods that return a FootnoteOption.