InDesign2026
API 21.5.1.73
Object

NotePreference

Note preferences.

Preference NotePreference
Hierarchy

Application

NotePreference

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean read/write If true, includes inline notes content when using Find/Change commands (in Galley and Story views only).
Boolean readonly Returns true if the object specifier resolves to valid objects.
NoteBackgrounds
read/write The background color for notes.
3 Reals (0 - 255)[] | InCopyUIColors[]
+53 more
read/write 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.
NoteColorChoices
read/write The color to use for notes.
Application readonly The parent of the NotePreference (a Application).
Object read/write A property that allows setting of several properties at the same time.
Boolean read/write 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.
Boolean read/write If true, includes inline notes content when using Spell Check (in Galley and Story views only).

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
NotePreference[]

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

Boolean

Removes the event listener.

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.
String

Generates a string which, if executed, will return the NotePreference.

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a NotePreference.

Return 1

Methods that return a NotePreference.