K4 InDesign Javascript API Documentation

PreferencesFootnoteOption

Options for specifying default footnote formatting.

Extends

Instance Properties

Name Description Access
continuingRuleColor 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. read-write
continuingRuleGapColor 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. read-write
continuingRuleGapOverprint bool If true, overprints the gap color of the rule above continued footnote text. Note: Valid when continuing rule type is not solid. read-write
continuingRuleGapTint number 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. read-write
continuingRuleLeftIndent Measurement Unit (Number or String)=any The amount to left indent the rule above continued footnote text. Note: Valid when continuing rule on is true. read-write
continuingRuleLineWeight Measurement Unit (Number or String)=any The stroke weight of the rule above continued footnote text. (Range: 0 to 1000) Note: Valid when continuing rule on is true. read-write
continuingRuleOffset Measurement Unit (Number or String)=any The vertical offset of the rule above continued footnote text. Note: Valid when continuing rule on is true. read-write
continuingRuleOn bool If true, draws a rule above footnote text that continues from a previous column. Note: Valid when no splitting is false or undefined. read-write
continuingRuleOverprint bool If true, overprints the rule above continued footnote text. Note: Valid when continuing rule on is true. read-write
continuingRuleTint number 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. read-write
continuingRuleType The stroke type of the rule above continued footnote text. Note: Valid when continuing rule on is true. Can return: StrokeStyle or String. read-write
continuingRuleWidth Measurement Unit (Number or String)=any The length of the rule above continued footnote text. Note: Valid when continuing rule on is true. read-write
enableStraddling bool If true, document will have straddling footnotes. If false, document will not have straddling footnotes. read-write
eosPlacement bool 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. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
footnoteFirstBaselineOffset FootnoteFirstBaseline The distance between the top of the footnote container and the footnote text. read-write
footnoteMarkerStyle CharacterStyle The character style to apply to footnote reference numbers in the main text. read-write
footnoteMinimumFirstBaselineOffset Measurement Unit (Number or String)=any The minimum distance between the baseline of the text and the top of the footnote container. read-write
footnoteNumberingStyle The footnote numbering style. Can return: FootnoteNumberingStyle enumerator or String. read-write
footnoteTextStyle ParagraphStyle 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. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
markerPositioning The position of footnote reference numbers in the main text. Can return: FootnoteMarkerPositioning enumerator or String. read-write
noSplitting bool 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. read-write
parent The parent of the FootnoteOption (a Application or Document). read-only
prefix string The prefix text of the footnote. (Limit: 0 to 100 characters) read-write
properties Object A property that allows setting of several properties at the same time. read-write
restartNumbering The point at which to restart footnote numbering. Can return: FootnoteRestarting enumerator or String. read-write
ruleColor 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. read-write
ruleGapColor 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. read-write
ruleGapOverprint bool If true, overprints the gap color of the rule above the first footnote in the column. Note: Valid when rule type is not solid. read-write
ruleGapTint number 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. read-write
ruleLeftIndent Measurement Unit (Number or String)=any The amount to left indent the rule above the first footnote in the column. Note: Valid when rule on is true. read-write
ruleLineWeight Measurement Unit (Number or String)=any The stroke weight of the rule above the first footnote in the column. (Range: 0 to 1000) Note: Valid when rule on is true. read-write
ruleOffset Measurement Unit (Number or String)=any The vertical offset of the rule above the first footnote in the column. Note: Valid when rule on is true. read-write
ruleOn bool If true, draws a rule between the text and the first footnote in the column. read-write
ruleOverprint bool If true, overprints the rule above the first footnote in the column. Note: Valid when rule on is true. read-write
ruleTint number 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. read-write
ruleType 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. read-write
ruleWidth Measurement Unit (Number or String)=any The length of the rule above the first footnote in the column. Note: Valid when rule on is true. read-write
separatorText string The text to insert between the footnote marker number and the footnote text. (Range: 0 to 100 characters) read-write
showPrefixSuffix The position of the footnote prefix and/or suffix. Can return: FootnotePrefixSuffix enumerator or String. read-write
spaceBetween Measurement Unit (Number or String)=any 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. read-write
spacer Measurement Unit (Number or String)=any 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. read-write
startAt number The number at which to start footnote numbering. read-write
suffix string The suffix text of the footnote. (Limit: 0 to 100 characters) read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → FootnoteOption
removeEventListener(
eventType, handler ​[, captures])
  → bool
toSource(
)
  → string
toSpecifier(
)
  → string
addEventListener(
eventType, handler ​[, captures=false])
  → EventListener
Adds an event listener.
eventType string The event type.
handler The event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
getElements(
)
  → FootnoteOption
Resolves the object specifier, creating an array of object references.
removeEventListener(
eventType, handler ​[, captures=false])
  → bool
Removes the event listener.
eventType string The registered event type.
handler The registered event handler. Can accept: File or JavaScript Function.
captures bool This parameter is obsolete. (Optional)
toSource(
)
  → string
Generates a string which, if executed, will return the FootnoteOption.
toSpecifier(
)
  → string
Retrieves the object specifier.