Endnote

Methods:

addEventListener, deleteEndnote, extractLabel, getElements, insertLabel, insertTextInEndnote, removeEventListener, toSource, toSpecifier

Objects:

Boolean, Characters, EndnoteRange, EventListeners, Events, InsertionPoints, Lines, Number, Object, String, TextColumns, TextStyleRanges, Texts, Words,

Property Listing

Property	Type	Access	Description
characters	Characters Character	readonly	A collection of characters.
endnoteTextRange	EndnoteRange	read/write	The endnote range object.
eventListeners	EventListeners EventListener	readonly	A collection of event listeners.
events	Events Event	readonly	A collection of events.
id	Number	readonly	The unique ID of the Endnote.
index	Number	readonly	The index of the Endnote within its containing object.
insertionPoints	InsertionPoints InsertionPoint	readonly	A collection of insertion points.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
label	String	read/write	A property that can be set to any string.
lines	Lines Line	readonly	A collection of lines.
name	String	read/write	The name of the Endnote; this is an alias to the Endnote's label property.
parent	Cell Story XmlStory InsertionPoint Table	readonly	The parent of the Endnote (a InsertionPoint, Story, XmlStory, Cell or Table).
properties	Object	read/write	A property that allows setting of several properties at the same time.
storyOffset	InsertionPoint	readonly	The location of the endnote marker in the parent story
textColumns	TextColumns TextColumn	readonly	A collection of text columns.
textStyleRanges	TextStyleRanges TextStyleRange	readonly	A collection of text style ranges.
texts	Texts Text	readonly	A collection of text objects.
words	Words Word	readonly	A collection of words.

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)

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)

undefined deleteEndnote ()

Deletes the endnote reference and the associated endnote text range.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

Endnote getElements ()

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

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

undefined insertTextInEndnote (storyOffset:InsertionPoint, contents:String)

Insert the text in endnote text range at specified text index. Insertion position should lie within the start and end range indices excluding the markers

Parameter	Type	Description
storyOffset	InsertionPoint	The location within the story, specified as an insertion point.
contents	String	The content to insert.

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)