A collection of notes.
Methods
Noteadd ([at:
LocationOptions=UNKNOWN ][, reference:
any][, withProperties:
Object])
Creates a new note.
| Parameter | Type | Description |
|---|---|---|
| at | LocationOptions : BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location relative to the reference object or within the containing object. (Optional) (default: UNKNOWN ) |
| reference | Note InsertionPoint |
The reference object. Note: Required when the at parameter specifies before or after. Can accept: Note or InsertionPoint. (Optional) |
| withProperties | Object | Initial values for properties of the new Note (Optional) |
NoteanyItem ()
Returns any Note in the collection.
number count ()
Displays the number of elements in the Note.
Array of NoteeveryItem ()
Returns every Note in the collection.
NotefirstItem ()
Returns the first Note in the collection.
Noteitem (index:
any)
Returns the Note with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
NoteitemByID (id:
number)
Returns the Note with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
NoteitemByName (name:
string)
Returns the Note with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of NoteitemByRange (from:
any, to:
any)
Returns the Notes within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Note Long Integer String |
The Note, index, or name at the beginning of the range. Can accept: Note, Long Integer or String. |
| to | Note Long Integer String |
The Note, index, or name at the end of the range. Can accept: Note, Long Integer or String. |
NotelastItem ()
Returns the last Note in the collection.
NotemiddleItem ()
Returns the middle Note in the collection.
NotenextItem (obj:
Note)
Returns the Note whose index follows the specified Note in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Note | The Note whose index comes before the desired Note. |
NotepreviousItem (obj:
Note)
Returns the Note with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Note | The index of the Note that follows the desired Note. |
string toSource ()
Generates a string which, if executed, will return the Note.
Element of:
Character.notes
InsertionPoint.notes
Line.notes
Paragraph.notes
Story.notes
Text.notes
TextColumn.notes
TextFrame.notes
TextStyleRange.notes
Word.notes
XmlStory.notes