Note

A note in a story.

Methods:

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

Objects:

Boolean, Characters, Date, InsertionPoints, Lines, Number, Object, Paragraphs, String, TextColumns, TextStyleRanges, 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

Text

TextColumn

TextFrame

Word

Story

TextStyleRange

readonly

The parent of the Note (a Story, TextFrame, InsertionPoint, Text, Character, Word, Line, TextColumn, Paragraph or TextStyleRange).

parentTextFrame

TextFrame

readonly

The text frame this note appears in.

properties

Object

read/write

A property that allows setting of several properties at the same time.

storyOffset

Number

readonly

The location of this note from the beginning of the story

textColumns

TextColumns TextColumn

readonly

A collection of text columns.

textStyleRanges

TextStyleRanges TextStyleRange

readonly

A collection of text style ranges.

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.

Object 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)

undefined remove ()

Deletes the Note.

String toSource ()

Generates a string which, if executed, will return the Note.

String toSpecifier ()

Retrieves the object specifier.

Object of

Character.parent

InsertionPoint.parent

Line.parent

Paragraph.parent

Text.parent

TextColumn.parent

TextStyleRange.parent

Word.parent

Return

Text.convertToNote()

Character.convertToNote()

Word.convertToNote()

Line.convertToNote()

TextColumn.convertToNote()

Paragraph.convertToNote()

TextStyleRange.convertToNote()

InsertionPoint.convertToNote()

Notes.add()

Note.move()

Notes.anyItem()

Notes.everyItem()

Notes.nextItem()

Notes.previousItem()

Notes.itemByID()

Notes.item()

Notes.itemByName()

Notes.itemByRange()

Notes.firstItem()

Notes.lastItem()

Notes.middleItem()