K4 InDesign Javascript API Documentation

PreferencesEndnoteOption

Options for specifying default endnote formatting.

Extends

Instance Properties

Name Description Access
endnoteMarkerPositioning The position of endnote reference numbers in the main text. Can return: FootnoteMarkerPositioning enumerator or String. read-write
endnoteMarkerStyle CharacterStyle The character style to apply to endnote reference numbers in the main text. read-write
endnoteNumberingStyle The endnote numbering style. Can return: FootnoteNumberingStyle enumerator or String. read-write
endnotePrefix string The prefix text of the endnote. (Limit: 0 to 100 characters) read-write
endnoteSeparatorText string The text to insert between the endnote marker number and the endnote text. (Range: 0 to 100 characters) read-write
endnoteSuffix string The suffix text of the endnote. (Limit: 0 to 100 characters) read-write
endnoteTextStyle ParagraphStyle The paragraph style to apply to endnote text. read-write
endnoteTitle string Title of the endnotes. (Limit: 0 to 100 characters) read-write
endnoteTitleStyle ParagraphStyle The paragraph style to apply to endnote title. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
frameCreateOption Frame creation of the endnotes. Can return: EndnoteFrameCreate enumerator or String. read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
parent The parent of the EndnoteOption (a Application or Document). read-only
properties Object A property that allows setting of several properties at the same time. read-write
restartEndnoteNumbering The point at which to restart endnote numbering. Can return: EndnoteRestarting enumerator or String. read-write
scopeValue Scope value of the endnotes. Can return: EndnoteScope enumerator or String. read-write
showEndnotePrefixSuffix The position of the endnote prefix and/or suffix. Can return: FootnotePrefixSuffix enumerator or String. read-write
startEndnoteNumberAt number The number at which to start endnote numbering. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → EndnoteOption
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(
)
  → EndnoteOption
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 EndnoteOption.
toSpecifier(
)
  → string
Retrieves the object specifier.