Options for specifying default footnote formatting, position, and so on.
footnote option Properties
| Property | Type | Access | Description |
|---|---|---|---|
| class | type class | read | The class descriptor type. |
| continuing rule color | anything | r/w | 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. |
| continuing rule gap color | anything | r/w | 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. |
| continuing rule gap overprint | boolean | r/w | If true, overprints the gap color of the rule above continued footnote text. Note: Valid when continuing rule type is not solid. |
| continuing rule gap tint | fixed | r/w | 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. |
| continuing rule left indent | number or string | r/w | The amount to left indent the rule above continued footnote text. Note: Valid when continuing rule on is true. |
| continuing rule line weight | number or string | r/w | The stroke weight of the rule above continued footnote text. (Range: 0 to 1000) Note: Valid when continuing rule on is true. |
| continuing rule offset | number or string | r/w | The vertical offset of the rule above continued footnote text. Note: Valid when continuing rule on is true. |
| continuing rule on | boolean | r/w | If true, draws a rule above footnote text that continues from a previous column. Note: Valid when no splitting is false or undefined. |
| continuing rule overprint | boolean | r/w | If true, overprints the rule above continued footnote text. Note: Valid when continuing rule on is true. |
| continuing rule tint | fixed | r/w | 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. |
| continuing rule type | anything | r/w | The stroke type of the rule above continued footnote text. Note: Valid when continuing rule on is true. Can return: stroke style or string. |
| continuing rule width | number or string | r/w | The length of the rule above continued footnote text. Note: Valid when continuing rule on is true. |
| eos placement | boolean | r/w | 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. |
| footnote first baseline offset | ascent offset, cap height, leading offset, embox height, x height, fixed height, |
r/w | The distance between the top of the footnote container and the footnote text. |
| footnote marker style | character style | r/w | The character style to apply to footnote reference numbers in the main text. |
| footnote minimum first baseline offset | number or string | r/w | The minimum distance between the baseline of the text and the top of the footnote container. |
| footnote numbering style | anything | r/w | The footnote numbering style. Can return: upper roman/lower roman/upper letters/lower letters/arabic/symbols or string. |
| footnote text style | paragraph style | r/w | 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. |
| marker positioning | anything | r/w | The position of footnote reference numbers in the main text. Can return: normal marker/superscript marker/subscript marker or string. |
| no splitting | boolean | r/w | 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. |
| object reference | footnote option | read | An object reference for the footnote option. |
| parent | reference | read | The parent of the footnote option (a application or document). Can return: application or document. |
| prefix | string | r/w | The prefix text of the footnote. (Limit: 0 to 100 characters) |
| properties | record | r/w | A property that allows setting of several properties at the same time. |
| restart numbering | anything | r/w | The point at which to restart footnote numbering. Can return: dont restart/page restart/spread restart/section restart or string. |
| rule color | anything | r/w | 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. |
| rule gap color | anything | r/w | 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. |
| rule gap overprint | boolean | r/w | If true, overprints the gap color of the rule above the first footnote in the column. Note: Valid when rule type is not solid. |
| rule gap tint | fixed | r/w | 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. |
| rule left indent | number or string | r/w | The amount to left indent the rule above the first footnote in the column. Note: Valid when rule on is true. |
| rule line weight | number or string | r/w | The stroke weight of the rule above the first footnote in the column. (Range: 0 to 1000) Note: Valid when rule on is true. |
| rule offset | number or string | r/w | The vertical offset of the rule above the first footnote in the column. Note: Valid when rule on is true. |
| rule on | boolean | r/w | If true, draws a rule between the text and the first footnote in the column. |
| rule overprint | boolean | r/w | If true, overprints the rule above the first footnote in the column. Note: Valid when rule on is true. |
| rule tint | fixed | r/w | 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. |
| rule type | anything | r/w | The stroke type of the rule above the first footnote in a column. Note: Valid when rule on is true. Can return: stroke style or string. |
| rule width | number or string | r/w | The length of the rule above the first footnote in the column. Note: Valid when rule on is true. |
| separator text | string | r/w | The text to insert between the footnote marker number and the footnote text. (Range: 0 to 100 characters) |
| show prefix suffix | anything | r/w | The position of the footnote prefix and/or suffix. Can return: no prefix suffix/prefix suffix reference/prefix suffix marker/prefix suffix both or string. |
| space between | number or string | r/w | 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. For information on the applied paragraph style, see footnote text style. |
| spacer | number or string | r/w | 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. For information on the applied pa… |
| start at | integer | r/w | The number at which to start footnote numbering |
| suffix | string | r/w | The suffix text of the footnote. (Limit: 0 to 100 characters) |