Adobe InDesign CS5 Server (7.0) Object Model JS: FootnoteOption

InDesign Server CS5

Class

FootnoteOption

 Options for specifying default footnote formatting. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
FootnoteOption
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
continuingRuleColorString
Swatch
r/wThe 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.
continuingRuleGapColorString
Swatch
r/wThe 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.
continuingRuleGapOverprintbool r/wIf true, overprints the gap color of the rule above continued footnote text. Note: Valid when continuing rule type is not solid.
continuingRuleGapTintnumber (range: 0 - 100) r/wThe 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.
continuingRuleLeftIndentMeasurement Unit (Number or String) (range: -103680 - 103680) r/wThe amount to left indent the rule above continued footnote text. Note: Valid when continuing rule on is true.
continuingRuleLineWeightMeasurement Unit (Number or String) (range: 0 - 1000) r/wThe stroke weight of the rule above continued footnote text. (Range: 0 to 1000) Note: Valid when continuing rule on is true.
continuingRuleOffsetMeasurement Unit (Number or String) (range: -15552 - 15552) r/wThe vertical offset of the rule above continued footnote text. Note: Valid when continuing rule on is true.
continuingRuleOnbool r/wIf true, draws a rule above footnote text that continues from a previous column. Note: Valid when no splitting is false or undefined.
continuingRuleOverprintbool r/wIf true, overprints the rule above continued footnote text. Note: Valid when continuing rule on is true.
continuingRuleTintnumber (range: 0 - 100) r/wThe tint (as a percentage) of the rule above continued footnote text. (Range: 0 to 100) Note: Valid when continuing rule type is not solid.
continuingRuleTypeString
StrokeStyle
r/wThe stroke type of the rule above continued footnote text. Note: Valid when continuing rule on is true. Can return: StrokeStyle or String.
continuingRuleWidthMeasurement Unit (Number or String) (range: 0 - 103680) r/wThe length of the rule above continued footnote text. Note: Valid when continuing rule on is true.
eosPlacementbool r/wIf 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.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
footnoteFirstBaselineOffsetFootnoteFirstBaseline:
FootnoteFirstBaseline.ASCENT_OFFSET
FootnoteFirstBaseline.CAP_HEIGHT
FootnoteFirstBaseline.LEADING_OFFSET
FootnoteFirstBaseline.EMBOX_HEIGHT
FootnoteFirstBaseline.X_HEIGHT
FootnoteFirstBaseline.FIXED_HEIGHT
r/wThe distance between the top of the footnote container and the footnote text.
footnoteMarkerStyleCharacterStyle r/wThe character style to apply to footnote reference numbers in the main text.
footnoteMinimumFirstBaselineOffsetMeasurement Unit (Number or String) (range: 0 - 103680) r/wThe minimum distance between the baseline of the text and the top of the footnote container.
footnoteNumberingStyleFootnoteNumberingStyle
String
r/wThe footnote numbering style. Can return: FootnoteNumberingStyle enumerator or String.
footnoteTextStyleParagraphStyle r/wThe 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.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
markerPositioningFootnoteMarkerPositioning
String
r/wThe position of footnote reference numbers in the main text. Can return: FootnoteMarkerPositioning enumerator or String.
noSplittingbool r/wIf 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.
parentApplication
Document
readonlyThe parent of the FootnoteOption (a Application or Document).
prefixstring r/wThe prefix text of the footnote. (Limit: 0 to 100 characters)
propertiesObject r/wA property that allows setting of several properties at the same time.
restartNumberingFootnoteRestarting
String
r/wThe point at which to restart footnote numbering. Can return: FootnoteRestarting enumerator or String.
ruleColorString
Swatch
r/wThe 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.
ruleGapColorString
Swatch
r/wThe 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.
ruleGapOverprintbool r/wIf true, overprints the gap color of the rule above the first footnote in the column. Note: Valid when rule type is not solid.
ruleGapTintnumber (range: 0 - 100) r/wThe 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.
ruleLeftIndentMeasurement Unit (Number or String) (range: -103680 - 103680) r/wThe amount to left indent the rule above the first footnote in the column. Note: Valid when rule on is true.
ruleLineWeightMeasurement Unit (Number or String) (range: 0 - 1000) r/wThe stroke weight of the rule above the first footnote in the column. (Range: 0 to 1000) Note: Valid when rule on is true.
ruleOffsetMeasurement Unit (Number or String) (range: -15552 - 15552) r/wThe vertical offset of the rule above the first footnote in the column. Note: Valid when rule on is true.
ruleOnbool r/wIf true, draws a rule between the text and the first footnote in the column.
ruleOverprintbool r/wIf true, overprints the rule above the first footnote in the column. Note: Valid when rule on is true.
ruleTintnumber (range: 0 - 100) r/wThe 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.
ruleTypeString
StrokeStyle
r/wThe stroke type of the rule above the first footnote in a column. Note: Valid when rule on is true. Can return: StrokeStyle or String.
ruleWidthMeasurement Unit (Number or String) (range: 0 - 103680) r/wThe length of the rule above the first footnote in the column. Note: Valid when rule on is true.
separatorTextstring r/wThe text to insert between the footnote marker number and the footnote text. (Range: 0 to 100 characters)
showPrefixSuffixFootnotePrefixSuffix
String
r/wThe position of the footnote prefix and/or suffix. Can return: FootnotePrefixSuffix enumerator or String.
spaceBetweenMeasurement Unit (Number or String) (range: 0 - 864) r/wThe amount of vertical space between footnotes. Note: The space before and space after defined for the paragraph style applied to the footnote is ignored.
spacerMeasurement Unit (Number or String) (range: 0 - 864) r/wThe 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.
startAtnumber (range: 1 - 100000) r/wThe number at which to start footnote numbering.
suffixstring r/wThe suffix text of the footnote. (Limit: 0 to 100 characters)

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

Array of FootnoteOption getElements ()
Resolves the object specifier, creating an array of object references.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

string toSource ()
Generates a string which, if executed, will return the FootnoteOption.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.footnoteOptions

Document.footnoteOptions

Return

Array of FootnoteOption FootnoteOption.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index