Note
A note in a story.
Note Properties
| Property |
Type |
Access |
Description |
| collapsed |
Boolean |
r/w |
Is the note collapsed in the galley window. |
| creationDate |
Date |
read |
When the note was created. |
| id |
Long |
read |
The object’s unique id. |
| index |
Long |
read |
Index of the object within its parent object. |
| label |
String |
r/w |
A label that can be set to any string. |
| modificationDate |
Date |
read |
When the note was last modified. |
| parent |
Object |
read |
The object’s parent. |
| parentTextFrame |
TextFrame |
read |
The text frame this note appears in. |
| properties |
An array of property names and values |
r/w |
Property that allows setting of several properties at the same time. |
| storyOffset |
Long |
read |
The location of this note from the beginning of the story. |
| userName |
String |
read |
The user who made the note. |
Note Methods
| Method |
Returns |
Description |
| convertToText |
Nothing |
Convert to text. |
| extractLabel |
String |
Get the label value associated with the given key. |
| getElements |
Array of Objects |
Resolve the object specifier. |
| insertLabel |
Nothing |
Set the label associated with the given key. |
| move |
Note |
Move before/after another text object, or to beginning/end. |
| remove |
Nothing |
Delete the object. |
| toSource |
String |
Generate JavaScript source that, if executed, will return the specified objects. |
| toSpecifier |
String |
Retrieve the object specifier. |