NotePreference
Note preferences.
Go to Property Listing | Method Listing
Methods:
addEventListener, getElements, removeEventListener, toSource, toSpecifier
Objects:
Boolean, EventListeners, Events, InCopyUIColors, NoteBackgrounds, NoteColorChoices, Object,
Hierarchy:
Superclass: Preference
Class: NotePreference
Property Listing
Property |
Type |
Access |
Description |
---|---|---|---|
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
read/write |
If true, includes inline notes content when using Find/Change commands (in Galley and Story views only). |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
read/write |
The background color for notes. |
||
Array of 3 Reals (0 - 255) |
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. |
|
read/write |
The color to use for notes. |
||
readonly |
The parent of the NotePreference (a Application). |
||
read/write |
A property that allows setting of several properties at the same time. |
||
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. |
||
read/write |
If true, includes inline notes content when using Spell Check (in Galley and Story views only). |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The event type. |
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
NotePreference getElements ()
Resolves the object specifier, creating an array of object references.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The registered event type. |
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the NotePreference.
String toSpecifier ()
Retrieves the object specifier.
Object of
Application.notePreferences
Event.parent
EventListener.parent
MutationEvent.parent