Adobe InCopy CS5 (7.0) Object Model JS: NotePreference

InCopy CS5

Class

NotePreference

 Note preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application
Preference
NotePreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
findAndReplaceNoteContentsbool r/wIf true, includes inline notes content when using Find/Change commands (in Galley and Story views only).
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
noteBackgroundColorNoteBackgrounds:
NoteBackgrounds.GALLEY_BACKGROUND_COLOR
NoteBackgrounds.USE_NOTE_COLOR
r/wThe background color for notes.
noteColor3 Reals (0 - 255)
InCopyUIColors
r/wThe 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.
noteColorChoicesNoteColorChoices:
NoteColorChoices.USE_USER_COLOR
NoteColorChoices.USE_NOTE_PREF_COLOR
r/wThe color to use for notes.
parentApplication readonlyThe parent of the NotePreference (a Application).
propertiesObject r/wA property that allows setting of several properties at the same time.
showNoteTipsbool r/wIf 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.
spellCheckNotesbool r/wIf 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.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.notePreferences

Return

Array of NotePreference NotePreference.getElements ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index