K4 InDesign Javascript API Documentation

TextEndnote

An endnote.

Instance Properties

Name Description Access
characters Characters A collection of characters. read-only
endnoteTextRange EndnoteRange The endnote range object. read-write
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the Endnote. read-only
index number The index of the Endnote within its containing object. read-only
insertionPoints InsertionPoints A collection of insertion points. read-only
isValid bool Returns true if the object specifier resolves to valid objects. read-only
label string A property that can be set to any string. read-write
lines Lines A collection of lines. read-only
name string The name of the Endnote; this is an alias to the Endnote's label property. read-write
parent The parent of the Endnote (a InsertionPoint, Story or XmlStory). read-only
properties Object A property that allows setting of several properties at the same time. read-write
storyOffset number The location of this endnote from the beginning of the story read-only
textColumns TextColumns A collection of text columns. read-only
textStyleRanges TextStyleRanges A collection of text style ranges. read-only
texts Texts A collection of text objects. read-only
words Words A collection of words. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
deleteEndnote(
)
extractLabel(
key)
  → string
getElements(
)
  → Endnote
insertLabel(
key, value)
insertTextInEndnote(
storyOffset, contents)
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)
deleteEndnote(
)
Deletes the endnote reference and the associated endnote text range.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → Endnote
Resolves the object specifier, creating an array of object references.
insertLabel(
key, value)
Sets the label to the value associated with the specified key.
key string The key.
value string The value.
insertTextInEndnote(
storyOffset, contents)
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
storyOffset InsertionPoint The location within the story, specified as an insertion point.
contents string The content to insert.
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 Endnote.
toSpecifier(
)
  → string
Retrieves the object specifier.