EndnoteOption

Options for specifying default endnote formatting.

Methods:

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Objects:

Boolean, CharacterStyle, EndnoteFrameCreate, EndnoteRestarting, EndnoteScope, EventListeners, Events, FootnoteMarkerPositioning, FootnoteNumberingStyle, FootnotePrefixSuffix, Number, Object, ParagraphStyle, String,

Hierarchy:

Superclass: Preference

Class: EndnoteOption

Property Listing

Property

Type

Access

Description

endnoteMarkerPositioning

FootnoteMarkerPositioning

FootnoteMarkerPositioning.NORMAL_MARKER

FootnoteMarkerPositioning.RUBY_MARKER

FootnoteMarkerPositioning.SUBSCRIPT_MARKER

FootnoteMarkerPositioning.SUPERSCRIPT_MARKER

String

read/write

The position of endnote reference numbers in the main text. Can return: FootnoteMarkerPositioning enumerator or String.

endnoteMarkerStyle

CharacterStyle

read/write

The character style to apply to endnote reference numbers in the main text.

endnoteNumberingStyle

FootnoteNumberingStyle

FootnoteNumberingStyle.ARABIC

FootnoteNumberingStyle.ARABIC_ABJAD

FootnoteNumberingStyle.ARABIC_ALIF_BA_TAH

FootnoteNumberingStyle.ASTERISKS

FootnoteNumberingStyle.DOUBLE_LEADING_ZEROS

FootnoteNumberingStyle.FULL_WIDTH_ARABIC

FootnoteNumberingStyle.HEBREW_BIBLICAL

FootnoteNumberingStyle.HEBREW_NON_STANDARD

FootnoteNumberingStyle.KANJI

FootnoteNumberingStyle.LOWER_LETTERS

FootnoteNumberingStyle.LOWER_ROMAN

FootnoteNumberingStyle.SINGLE_LEADING_ZEROS

FootnoteNumberingStyle.SYMBOLS

FootnoteNumberingStyle.UPPER_LETTERS

FootnoteNumberingStyle.UPPER_ROMAN

String

read/write

The endnote numbering style. Can return: FootnoteNumberingStyle enumerator or String.

endnotePrefix

String

read/write

The prefix text of the endnote. (Limit: 0 to 100 characters)

endnoteSeparatorText

String (range 0 - 100)

read/write

The text to insert between the endnote marker number and the endnote text. (Range: 0 to 100 characters)

endnoteSuffix

String

read/write

The suffix text of the endnote. (Limit: 0 to 100 characters)

endnoteTextStyle

ParagraphStyle

read/write

The paragraph style to apply to endnote text.

endnoteTitle

String

read/write

Title of the endnotes. (Limit: 0 to 100 characters)

endnoteTitleStyle

ParagraphStyle

read/write

The paragraph style to apply to endnote title.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

readonly

A collection of events.

frameCreateOption

EndnoteFrameCreate

EndnoteFrameCreate.LOAD_ENDNOTE_PLACE_GUN

EndnoteFrameCreate.NEW_PAGE

String

read/write

Frame creation of the endnotes. Can return: EndnoteFrameCreate enumerator or String.

isValid

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

parent

Application

Document

readonly

The parent of the EndnoteOption (a Application or Document).

properties

Object

read/write

A property that allows setting of several properties at the same time.

restartEndnoteNumbering

EndnoteRestarting

EndnoteRestarting.CONTINUOUS

EndnoteRestarting.STORY_RESTART

String

read/write

The point at which to restart endnote numbering. Can return: EndnoteRestarting enumerator or String.

scopeValue

EndnoteScope

EndnoteScope.ENDNOTE_DOCUMENT_SCOPE

EndnoteScope.STORY_SCOPE

String

read/write

Scope value of the endnotes. Can return: EndnoteScope enumerator or String.

showEndnotePrefixSuffix

FootnotePrefixSuffix

FootnotePrefixSuffix.NO_PREFIX_SUFFIX

FootnotePrefixSuffix.PREFIX_SUFFIX_BOTH

FootnotePrefixSuffix.PREFIX_SUFFIX_MARKER

FootnotePrefixSuffix.PREFIX_SUFFIX_REFERENCE

String

read/write

The position of the endnote prefix and/or suffix. Can return: FootnotePrefixSuffix enumerator or String.

startEndnoteNumberAt

Number (range 1 - 100000)

read/write

The number at which to start endnote numbering.

Method Listing

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

Adds an event listener.

Parameter

Type

Description

eventType

String

The event type.

handler

File

JavaScriptFunction

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

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

EndnoteOption getElements ()

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

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

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

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

captures

Boolean

This parameter is obsolete. (Optional)

(default: false)

String toSource ()

Generates a string which, if executed, will return the EndnoteOption.

String toSpecifier ()

Retrieves the object specifier.

Object of

Application.endnoteOptions

Document.endnoteOptions

Event.parent

EventListener.parent

MutationEvent.parent

Return

EndnoteOption.getElements()