K4 InDesign Javascript API Documentation

TextNote

A note in a story.

Instance Properties

Name Description Access
characters Characters A collection of characters. read-only
collapsed bool If true, the note is collapsed in galley view. read-write
creationDate Date The date and time the note was created. read-only
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
hiddenTexts HiddenTexts A collection of hidden text objects. read-only
id number The unique ID of the Note. read-only
index number The index of the Note 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
modificationDate Date The date and time the note was last modified. read-only
name string The name of the Note; this is an alias to the Note's label property. read-write
paragraphs Paragraphs A collection of paragraphs. read-only
parent The parent of the Note (a XmlStory, Story, TextFrame, EndnoteTextFrame, InsertionPoint or Cell). read-only
properties Object A property that allows setting of several properties at the same time. read-write
storyOffset InsertionPoint The insertion point before the table in the story containing the table. read-only
textColumns TextColumns A collection of text columns. read-only
textStyleRanges TextStyleRanges A collection of text style ranges. read-only
textVariableInstances TextVariableInstances A collection of text variable instances. read-only
texts Texts A collection of text objects. read-only
userName string The user who made the note. read-only
words Words A collection of words. read-only

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
convertToText(
)
extractLabel(
key)
  → string
getElements(
)
  → Note
insertLabel(
key, value)
move(
to, reference)
  → Note
remove(
)
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)
convertToText(
)
Converts the note to story text.
extractLabel(
key)
  → string
Gets the label value associated with the specified key.
key string The key.
getElements(
)
  → Note
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.
move(
to, reference)
  → Note
Moves the note to the specified location.
to LocationOptions The new location relative to the reference object or within the containing object.
reference The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text or Story. (Optional)
remove(
)
Deletes the Note.
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 Note.
toSpecifier(
)
  → string
Retrieves the object specifier.