K4 InDesign Javascript API Documentation

TextEndnoteRange

An endnote text range.

Instance Properties

Name Description Access
endnoteRangeContent EndnoteRange Contents, It will skip the endnote number while setting/replacing the content into endnote range. Can return: String, SpecialCharacters enumerator or Array of Strings or SpecialCharacters enumerators. Can also accept: NothingEnum enumerator or Array of Strings, SpecialCharacters enumerators or NothingEnum enumerators. read-write
endnoteRangeEndIndex number Ending Index of the endnote range object. read-only
endnoteRangeStartIndex number Starting Index of the endnote range object. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
id number The unique ID of the EndnoteRange. read-only
index number The index of the EndnoteRange within its containing object. 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
name string The name of the EndnoteRange; this is an alias to the EndnoteRange's label property. read-write
parent The parent of the EndnoteRange (a Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story or XmlStory). read-only
properties Object A property that allows setting of several properties at the same time. read-write
sourceEndnote Endnote The endnote reference corresponding to the endnote text range. read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
deleteEndnoteRange(
)
extractLabel(
key)
  → string
getElements(
)
  → EndnoteRange
insertLabel(
key, value)
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)
deleteEndnoteRange(
)
Deletes the endnote range and the associated endnote anchor.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → EndnoteRange
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.
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 EndnoteRange.
toSpecifier(
)
  → string
Retrieves the object specifier.