K4 InDesign Javascript API Documentation

PreferencesNotePreference

Note preferences.

Extends

Instance Properties

Name Description Access
eventListeners EventListeners A collection of event listeners. read-only
events Events A collection of events. read-only
findAndReplaceNoteContents bool If true, includes inline notes content when using Find/Change commands (in Galley and Story views only). read-write
isValid bool Returns true if the object specifier resolves to valid objects. read-only
noteBackgroundColor NoteBackgrounds The background color for notes. read-write
noteColor The note color, specified either as an array of three doubles, each in the range 0 to 255 and representing R, G, and B values, or as an InCopy UI color. Can return: Array of 3 Reals (0 - 255) or InCopyUIColors enumerator. read-write
noteColorChoices NoteColorChoices The color to use for notes. read-write
parent Application The parent of the NotePreference (a Application). read-only
properties Object A property that allows setting of several properties at the same time. read-write
showNoteTips bool If true, displays note information and some note content when the mouse pointer hovers over a note anchor in layout view or a note bookend in galley or story view. read-write
spellCheckNotes bool If true, includes inline notes content when using Spell Check (in Galley and Story views only). read-write

Methods

addEventListener(
eventType, handler ​[, captures])
  → EventListener
getElements(
)
  → NotePreference
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)
getElements(
)
  → NotePreference
Resolves the object specifier, creating an array of object references.
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 NotePreference.
toSpecifier(
)
  → string
Retrieves the object specifier.