Class

Notes

 A collection of notes.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

Property	Type	Access	Description
length	number	readonly	The number of objects in the collection.

Methods

Instances

Note [] (index: number)
Returns the Note with the specified index.

Parameter	Type	Description
index	number	The index.

Note add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new note.

Parameter	Type	Description
at	LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN	The location relative to the reference object or within the containing object. (Optional) (default: LocationOptions.UNKNOWN)
reference	InsertionPoint Note	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)

Note anyItem ()
Returns any Note in the collection.

number count ()
Displays the number of elements in the Note.

Array of Note everyItem ()
Returns every Note in the collection.

Note firstItem ()
Returns the first Note in the collection.

Note item (index: varies)
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.

Note itemByID (id: number)
Returns the Note with the specified ID.

Parameter	Type	Description
id	number	The ID.

Note itemByName (name: string)
Returns the Note with the specified name.

Parameter	Type	Description
name	string	The name.

Array of Note itemByRange (from: varies, to: varies)
Returns the Notes within the specified range.

Parameter	Type	Description
from	Long Integer Note String	The Note, index, or name at the beginning of the range. Can accept: Note, Long Integer or String.
to	Long Integer Note String	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	Note	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	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

Cell.notes

Character.notes

InsertionPoint.notes

Line.notes

Paragraph.notes

Story.notes

Table.notes

Text.notes

TextColumn.notes

TextFrame.notes

TextStyleRange.notes

Word.notes

XmlStory.notes

Jongware, 23-Mar-2011 v3.0.3d

Contents :: Index