FootnoteOption

Options for specifying default footnote formatting.

Go to Property Listing | Method Listing

Methods:

toSource, getElements, toSpecifier, addEventListener, removeEventListener

Objects:

Application, Boolean, CharacterStyle, Document, EventListeners, Events, FootnoteFirstBaseline, FootnoteMarkerPositioning, FootnoteNumberingStyle, FootnotePrefixSuffix, FootnoteRestarting, Number, Object, ParagraphStyle, String, StrokeStyle, Swatch,

Superclass:

Preference

Property Listing

Property	Type	Access	Description
continuingRuleColor	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.
continuingRuleGapColor	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.
continuingRuleGapOverprint	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.
continuingRuleGapTint	Number (range 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.
continuingRuleLeftIndent	Number String	read/write	The amount to left indent the rule above continued footnote text. Note: Valid when continuing rule on is true.
continuingRuleLineWeight	Number String	read/write	The stroke weight of the rule above continued footnote text. (Range: 0 to 1000) Note: Valid when continuing rule on is true.
continuingRuleOffset	Number String	read/write	The vertical offset of the rule above continued footnote text. Note: Valid when continuing rule on is true.
continuingRuleOn	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.
continuingRuleOverprint	Boolean	read/write	If true, overprints the rule above continued footnote text. Note: Valid when continuing rule on is true.
continuingRuleTint	Number (range 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.
continuingRuleType	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.
continuingRuleWidth	Number String	read/write	The length of the rule above continued footnote text. Note: Valid when continuing rule on is true.
eosPlacement	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	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
footnoteFirstBaselineOffset	FootnoteFirstBaseline FootnoteFirstBaseline.ASCENT_OFFSET FootnoteFirstBaseline.CAP_HEIGHT FootnoteFirstBaseline.LEADING_OFFSET FootnoteFirstBaseline.EMBOX_HEIGHT FootnoteFirstBaseline.X_HEIGHT FootnoteFirstBaseline.FIXED_HEIGHT	read/write	The distance between the top of the footnote container and the footnote text.
footnoteMarkerStyle	CharacterStyle	read/write	The character style to apply to footnote reference numbers in the main text.
footnoteMinimumFirstBaselineOffset	Number String	read/write	The minimum distance between the baseline of the text and the top of the footnote container.
footnoteNumberingStyle	FootnoteNumberingStyle FootnoteNumberingStyle.UPPER_ROMAN FootnoteNumberingStyle.LOWER_ROMAN FootnoteNumberingStyle.UPPER_LETTERS FootnoteNumberingStyle.LOWER_LETTERS FootnoteNumberingStyle.ARABIC FootnoteNumberingStyle.SYMBOLS FootnoteNumberingStyle.KANJI FootnoteNumberingStyle.FULL_WIDTH_ARABIC FootnoteNumberingStyle.SINGLE_LEADING_ZEROS FootnoteNumberingStyle.DOUBLE_LEADING_ZEROS FootnoteNumberingStyle.ASTERISKS FootnoteNumberingStyle.ARABIC_ALIF_BA_TAH FootnoteNumberingStyle.ARABIC_ABJAD FootnoteNumberingStyle.HEBREW_BIBLICAL FootnoteNumberingStyle.HEBREW_NON_STANDARD String	read/write	The footnote numbering style. Can return: FootnoteNumberingStyle enumerator or String.
footnoteTextStyle	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.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
markerPositioning	FootnoteMarkerPositioning FootnoteMarkerPositioning.NORMAL_MARKER FootnoteMarkerPositioning.SUPERSCRIPT_MARKER FootnoteMarkerPositioning.SUBSCRIPT_MARKER FootnoteMarkerPositioning.RUBY_MARKER String	read/write	The position of footnote reference numbers in the main text. Can return: FootnoteMarkerPositioning enumerator or String.
noSplitting	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.
parent	Application Document	readonly	The parent of the FootnoteOption (a Application or Document).
prefix	String	read/write	The prefix text of the footnote. (Limit: 0 to 100 characters)
properties	Object	read/write	A property that allows setting of several properties at the same time.
restartNumbering	FootnoteRestarting FootnoteRestarting.DONT_RESTART FootnoteRestarting.PAGE_RESTART FootnoteRestarting.SPREAD_RESTART FootnoteRestarting.SECTION_RESTART String	read/write	The point at which to restart footnote numbering. Can return: FootnoteRestarting enumerator or String.
ruleColor	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.
ruleGapColor	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.
ruleGapOverprint	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.
ruleGapTint	Number (range 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.
ruleLeftIndent	Number String	read/write	The amount to left indent the rule above the first footnote in the column. Note: Valid when rule on is true.
ruleLineWeight	Number String	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.
ruleOffset	Number String	read/write	The vertical offset of the rule above the first footnote in the column. Note: Valid when rule on is true.
ruleOn	Boolean	read/write	If true, draws a rule between the text and the first footnote in the column.
ruleOverprint	Boolean	read/write	If true, overprints the rule above the first footnote in the column. Note: Valid when rule on is true.
ruleTint	Number (range 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.
ruleType	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.
ruleWidth	Number String	read/write	The length of the rule above the first footnote in the column. Note: Valid when rule on is true.
separatorText	String (range 0 - 100)	read/write	The text to insert between the footnote marker number and the footnote text. (Range: 0 to 100 characters)
showPrefixSuffix	FootnotePrefixSuffix FootnotePrefixSuffix.NO_PREFIX_SUFFIX FootnotePrefixSuffix.PREFIX_SUFFIX_REFERENCE FootnotePrefixSuffix.PREFIX_SUFFIX_MARKER FootnotePrefixSuffix.PREFIX_SUFFIX_BOTH String	read/write	The position of the footnote prefix and/or suffix. Can return: FootnotePrefixSuffix enumerator or String.
spaceBetween	Number String	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.
spacer	Number String	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.
startAt	Number (range 1 - 100000)	read/write	The number at which to start footnote numbering.
suffix	String	read/write	The suffix text of the footnote. (Limit: 0 to 100 characters)

Method Listing

EventListener addEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])

Adds an event listener.

Parameter	Type	Description
eventType	String	The event type.
handler	Varies	The event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)

Parameter

Type

Description

eventType

String

The event type.

handler

Varies

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

FootnoteOption getElements ()

Resolves the object specifier, creating an array of object references.

Boolean removeEventListener (eventType:String, handler:Varies, [captures:Boolean=Boolean])

Removes the event listener.

Parameter	Type	Description
eventType	String	The registered event type.
handler	Varies	The registered event handler. Can accept: File or JavaScript Function.
captures	Boolean	This parameter is obsolete. (Optional) (default: false)