Edit in GitHubLog an issue

NotePreference

Note preferences.

Instance

Read Only

Boolean isValid

Returns true if the object specifier resolves to valid objects.


Read Only

Application parent

The parent of the NotePreference (a Application).


Read Only

Events events

A collection of events.


Read Only

EventListeners eventListeners

A collection of event listeners.


NoteBackgrounds noteBackgroundColor

The background color for notes.


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


Boolean showNoteTips

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 findAndReplaceNoteContents

If true, includes inline notes content when using Find/Change commands (in Galley and Story views only).


Boolean spellCheckNotes

If true, includes inline notes content when using Spell Check (in Galley and Story views only).


NoteColorChoices noteColorChoices

The color to use for notes.


Object properties

A property that allows setting of several properties at the same time.

Methods

String toSource()

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


NotePreference getElements()

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


String toSpecifier()

Retrieves the object specifier.


EventListener addEventListener( String eventType, Mixed handler, Boolean captures )

Adds an event listener.

Parameters

TypeNameDescription
String
eventType
The event type.
Mixed
handler
The event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)

Boolean removeEventListener( String eventType, Mixed handler, Boolean captures )

Removes the event listener.

Parameters

TypeNameDescription
String
eventType
The registered event type.
Mixed
handler
The registered event handler. Can accept: File or JavaScript Function.
Boolean
captures
This parameter is obsolete. (Optional)
Was this helpful?
  • Privacy
  • Terms of Use
  • Do not sell or share my personal information
  • AdChoices
Copyright © 2023 Adobe. All rights reserved.