Adobe InDesign CS3 (5.0) Object Model JS: FootnoteOption

InDesign CS3

previous page next page

Class

FootnoteOption

Options for specifying default footnote formatting.

QuickLinks

getElements, toSource, toSpecifier

Hierarchy

Application | Document

FootnoteOption

Properties

Property	Type	Access	Description
continuingRuleColor	String Swatch	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.
continuingRuleGapColor	String Swatch	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.
continuingRuleGapOverprint	bool	r/w	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)	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.
continuingRuleLeftIndent	Measurement Unit (Number or String) (range: -103680 - 103680)	r/w	The amount to left indent the rule above continued footnote text. Note: Valid when continuing rule on is true.
continuingRuleLineWeight	Measurement Unit (Number or String) (range: 0 - 1000)	r/w	The stroke weight of the rule above continued footnote text. (Range: 0 to 1000) Note: Valid when continuing rule on is true.
continuingRuleOffset	Measurement Unit (Number or String) (range: -15552 - 15552)	r/w	The vertical offset of the rule above continued footnote text. Note: Valid when continuing rule on is true.
continuingRuleOn	bool	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.
continuingRuleOverprint	bool	r/w	If true, overprints the rule above continued footnote text. Note: Valid when continuing rule on is true.
continuingRuleTint	number (range: 0 - 100)	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.
continuingRuleType	String StrokeStyle	r/w	The stroke type of the rule above continued footnote text. Note: Valid when continuing rule on is true. Can return: StrokeStyle or String.
continuingRuleWidth	Measurement Unit (Number or String) (range: 0 - 103680)	r/w	The length of the rule above continued footnote text. Note: Valid when continuing rule on is true.
eosPlacement	bool	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.
footnoteFirstBaselineOffset	FootnoteFirstBaseline: FootnoteFirstBaseline.ASCENT_OFFSET FootnoteFirstBaseline.CAP_HEIGHT FootnoteFirstBaseline.LEADING_OFFSET FootnoteFirstBaseline.EMBOX_HEIGHT FootnoteFirstBaseline.X_HEIGHT FootnoteFirstBaseline.FIXED_HEIGHT	r/w	The distance between the top of the footnote container and the footnote text.
footnoteMarkerStyle	CharacterStyle	r/w	The character style to apply to footnote reference numbers in the main text.
footnoteMinimumFirstBaselineOffset	Measurement Unit (Number or String) (range: 0 - 103680)	r/w	The minimum distance between the baseline of the text and the top of the footnote container.
footnoteNumberingStyle	FootnoteNumberingStyle String	r/w	The footnote numbering style. Can return: FootnoteNumberingStyle enumerator or String.
footnoteTextStyle	ParagraphStyle	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.
markerPositioning	FootnoteMarkerPositioning String	r/w	The position of footnote reference numbers in the main text. Can return: FootnoteMarkerPositioning enumerator or String.
noSplitting	bool	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.
parent	Application Document	readonly	The parent of the FootnoteOption (a Application or Document).
prefix	string	r/w	The prefix text of the footnote. (Limit: 0 to 100 characters)
properties	Object	r/w	A property that allows setting of several properties at the same time.
restartNumbering	FootnoteRestarting String	r/w	The point at which to restart footnote numbering. Can return: FootnoteRestarting enumerator or String.
ruleColor	String Swatch	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.
ruleGapColor	String Swatch	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.
ruleGapOverprint	bool	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.
ruleGapTint	number (range: 0 - 100)	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.
ruleLeftIndent	Measurement Unit (Number or String) (range: -103680 - 103680)	r/w	The amount to left indent the rule above the first footnote in the column. Note: Valid when rule on is true.
ruleLineWeight	Measurement Unit (Number or String) (range: 0 - 1000)	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.
ruleOffset	Measurement Unit (Number or String) (range: -15552 - 15552)	r/w	The vertical offset of the rule above the first footnote in the column. Note: Valid when rule on is true.
ruleOn	bool	r/w	If true, draws a rule between the text and the first footnote in the column.
ruleOverprint	bool	r/w	If true, overprints the rule above the first footnote in the column. Note: Valid when rule on is true.
ruleTint	number (range: 0 - 100)	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.
ruleType	String StrokeStyle	r/w	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	Measurement Unit (Number or String) (range: 0 - 103680)	r/w	The length of the rule above the first footnote in the column. Note: Valid when rule on is true.
separatorText	string	r/w	The text to insert between the footnote marker number and the footnote text. (Range: 0 to 100 characters)
showPrefixSuffix	FootnotePrefixSuffix String	r/w	The position of the footnote prefix and/or suffix. Can return: FootnotePrefixSuffix enumerator or String.
spaceBetween	Measurement Unit (Number or String) (range: 0 - 864)	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.
spacer	Measurement Unit (Number or String) (range: 0 - 864)	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.
startAt	number (range: 1 - 100000)	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)

Methods

Instances

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

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, 27-Jun-2010 v3.0.3d

Contents :: Index

previous page start next page