Class
Note preferences. Base Class: Preference addEventListener, getElements, removeEventListener, toSource, toSpecifier
NotePreference
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| findAndReplaceNoteContents | bool | r/w | If true, includes inline notes content when using Find/Change commands (in Galley and Story views only). |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| noteBackgroundColor | NoteBackgrounds: NoteBackgrounds.GALLEY_BACKGROUND_COLOR NoteBackgrounds.USE_NOTE_COLOR |
r/w | The background color for notes. |
| noteColor | 3 Reals (0 - 255) InCopyUIColors |
r/w | 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 | NoteColorChoices: NoteColorChoices.USE_USER_COLOR NoteColorChoices.USE_NOTE_PREF_COLOR |
r/w | The color to use for notes. |
| parent | Application | readonly | The parent of the NotePreference (a Application). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| showNoteTips | bool | r/w | 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. |
| spellCheckNotes | bool | r/w | If true, includes inline notes content when using Spell Check (in Galley and Story views only). |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
Array
of NotePreference getElements ()
Resolves the object specifier, creating an array of object references.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the NotePreference.
Element of
Application.notePreferences
Return
Array of NotePreference NotePreference.getElements ()
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |