Notes
A collection of notes.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
Note [] (index:Number)
Returns the Note with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Note add ([at:LocationOptions=LocationOptions], reference:Varies Note InsertionPoint, withProperties:Object)
Creates a new note.
|
Parameter |
Type |
Description |
|---|---|---|
|
at |
The location relative to the reference object or within the containing object. (Optional) (default: LocationOptions.UNKNOWN) |
|
|
reference |
The reference object. Note: Required when the at parameter specifies before or after. Can accept: Note or InsertionPoint. (Optional) |
|
|
withProperties |
Initial values for properties of the new Note (Optional) |
Note anyItem ()
Returns any Note in the collection.
Number count ()
Displays the number of elements in the Note.
Note everyItem ()
Returns every Note in the collection.
Note firstItem ()
Returns the first Note in the collection.
Note item (index:Varies LongInteger String)
Returns the Note with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
Note itemByID (id:Number)
Returns the Note with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
Note itemByName (name:String)
Returns the Note with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Note itemByRange (from:Varies LongInteger Note String, to:Varies LongInteger Note String)
Returns the Notes within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The Note, index, or name at the beginning of the range. Can accept: Note, Long Integer or String. |
|
to |
LongInteger |
The Note, index, or name at the end of the range. Can accept: Note, Long Integer or String. |
Note lastItem ()
Returns the last Note in the collection.
Note middleItem ()
Returns the middle Note in the collection.
Note nextItem (obj:Note)
Returns the Note whose index follows the specified Note in the collection.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The Note whose index comes before the desired Note. |
Note previousItem (obj:Note)
Returns the Note with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the Note that follows the desired Note. |
String toSource ()
Generates a string which, if executed, will return the Note.
Object of
Cell.notes
Table.notes
Text.notes
Character.notes
Word.notes
Line.notes
TextColumn.notes
Paragraph.notes
TextStyleRange.notes
InsertionPoint.notes
TextFrame.notes
Story.notes
EndnoteTextFrame.notes
XmlStory.notes