Note

Methods:

convertToText, extractLabel, getElements, insertLabel, move, remove, toSource, toSpecifier

Objects:

Boolean, Characters, Date, InsertionPoints, Lines, Number, Object, Paragraphs, String, TextColumns, TextStyleRanges, TextVariableInstances, Texts, Words,

Property Listing

Property	Type	Access	Description
characters	Characters Character	readonly	A collection of characters.
collapsed	Boolean	read/write	If true, the note is collapsed in galley view.
creationDate	Date	readonly	The date and time the note was created.
id	Number	readonly	The unique ID of the Note.
index	Number	readonly	The index of the Note within its containing object.
insertionPoints	InsertionPoints InsertionPoint	readonly	A collection of insertion points.
label	String	read/write	A property that can be set to any string.
lines	Lines Line	readonly	A collection of lines.
modificationDate	Date	readonly	The date and time the note was last modified.
paragraphs	Paragraphs Paragraph	readonly	A collection of paragraphs.
parent	Character InsertionPoint Line Paragraph Story Text TextColumn TextFrame Word TextStyleRange XmlStory	readonly	The parent of the Note (a XmlStory, Story, TextFrame, InsertionPoint, Text, Character, Word, Line, TextColumn, Paragraph or TextStyleRange).
properties	Object	read/write	A property that allows setting of several properties at the same time.
storyOffset	InsertionPoint	readonly	The insertion point before the table in the story containing the table.
textColumns	TextColumns TextColumn	readonly	A collection of text columns.
textStyleRanges	TextStyleRanges TextStyleRange	readonly	A collection of text style ranges.
textVariableInstances	TextVariableInstances TextVariableInstance	readonly	A collection of text variable instances.
texts	Texts Text	readonly	A collection of text objects.
userName	String	readonly	The user who made the note.
words	Words Word	readonly	A collection of words.

Method Listing

undefined convertToText ()

Converts the note to story text.

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

Note getElements ()

Resolves the object specifier, creating an array of object references.

undefined insertLabel (key:String, value:String)

Sets the label to the value associated with the specified key.

Parameter	Type	Description
key	String	The key.
value	String	The value.

Note move (to:LocationOptions, reference:Varies Text Story)

Moves the note to the specified location.

Parameter	Type	Description
to	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The new location relative to the reference object or within the containing object.
reference	Text Story	The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text or Story. (Optional)

Parameter

Type

Description

to

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The new location relative to the reference object or within the containing object.

reference