TextNotes

A collection of notes.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[at], reference ​[, withProperties])
 → Note
anyItem(
)
 → Note
count(
)
 → number
everyItem(
)
 → Note
firstItem(
)
 → Note
item(
index)
 → Note
itemByID(
id)
 → Note
itemByName(
name)
 → Note
itemByRange(
from, to)
 → Note
lastItem(
)
 → Note
middleItem(
)
 → Note
nextItem(
obj)
 → Note
previousItem(
obj)
 → Note
toSource(
)
 → string
add(
[at=LocationOptions.UNKNOWN], reference ​[, withProperties])
 → Note
Creates a new note.
at LocationOptions The location relative to the reference object or within the containing object. (Optional)
reference 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)
anyItem(
)
 → Note
Returns any Note in the collection.
count(
)
 → number
Displays the number of elements in the Note.
everyItem(
)
 → Note
Returns every Note in the collection.
firstItem(
)
 → Note
Returns the first Note in the collection.
item(
index)
 → Note
Returns the Note with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByID(
id)
 → Note
Returns the Note with the specified ID.
id number The ID.
itemByName(
name)
 → Note
Returns the Note with the specified name.
name string The name.
itemByRange(
from, to)
 → Note
Returns the Notes within the specified range.
from The Note, index, or name at the beginning of the range. Can accept: Note, Long Integer or String.
to The Note, index, or name at the end of the range. Can accept: Note, Long Integer or String.
lastItem(
)
 → Note
Returns the last Note in the collection.
middleItem(
)
 → Note
Returns the middle Note in the collection.
nextItem(
obj)
 → Note
Returns the Note whose index follows the specified Note in the collection.
obj Note The Note whose index comes before the desired Note.
previousItem(
obj)
 → Note
Returns the Note with the index previous to the specified index.
obj Note The index of the Note that follows the desired Note.
toSource(
)
 → string
Generates a string which, if executed, will return the Note.