InDesign Server2025
InDesign2026 InDesign Server2025 Illustrator29 PhotoshopCC 2015.5 Bridge2021 Core JavaScriptExtendScript only ScriptUIExtendScript only
API 20.5.0.49
Object

Note

A note in a story.

Hierarchy

Cell | EndnoteTextFrame | InsertionPoint | Story | TextFrame | XmlStory

Note

Character | HiddenText | InsertionPoint | Line | Paragraph | Text | TextColumn | TextStyleRange | TextVariableInstance | Word

Properties

NameType AccessDescription
Characters<Character> readonly A collection of characters.
Boolean read/write If true, the note is collapsed in galley view.
Date readonly The date and time the note was created.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
HiddenTexts<HiddenText> readonly A collection of hidden text objects.
Number readonly The unique ID of the Note.
Number readonly The index of the Note within its containing object.
InsertionPoints<InsertionPoint> readonly A collection of insertion points.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
Lines<Line> readonly A collection of lines.
Date readonly The date and time the note was last modified.
String read/write The name of the Note; this is an alias to the Note's label property.
Paragraphs<Paragraph> readonly A collection of paragraphs.
EndnoteTextFrame | InsertionPoint | Story | TextFrame | Cell | XmlStory readonly The parent of the Note (a XmlStory, Story, TextFrame, EndnoteTextFrame, InsertionPoint or Cell).
Object read/write A property that allows setting of several properties at the same time.
InsertionPoint readonly The insertion point before the table in the story containing the table.
TextColumns<TextColumn> readonly A collection of text columns.
TextStyleRanges<TextStyleRange> readonly A collection of text style ranges.
TextVariableInstances<TextVariableInstance> readonly A collection of text variable instances.
Texts<Text> readonly A collection of text objects.
String readonly The user who made the note.
Words<Word> readonly A collection of words.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ void

Converts the note to story text.

→ String

Gets the label value associated with the specified key.

key String The key.
→ Note[]

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

→ void

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

key String The key.
value String The value.
→ Note

Moves the note to the specified location.

to LocationOptions 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.
→ void

Deletes the Note.

→ Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
→ String

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

→ String

Retrieves the object specifier.

Object of 13

Properties elsewhere that hold a Note.

Character.parentEvent.parentEventListener.parentHiddenText.parentInsertionPoint.parentLine.parentMutationEvent.parentParagraph.parentText.parentTextColumn.parentTextStyleRange.parentTextVariableInstance.parentWord.parent

Parameter of 6

Method parameters that accept a Note.

Footnotes.add(reference)Notes.add(reference)Notes.itemByRange(from)Notes.nextItem(obj)Notes.previousItem(obj)TextVariableInstances.add(reference)

Return 23

Methods that return a Note.

Character.convertToNote()InsertionPoint.convertToNote()Line.convertToNote()Note.getElements()Note.move()Notes.[]()Notes.add()Notes.anyItem()Notes.everyItem()Notes.firstItem()Notes.item()Notes.itemByID()Notes.itemByName()Notes.itemByRange()Notes.lastItem()Notes.middleItem()Notes.nextItem()Notes.previousItem()Paragraph.convertToNote()Text.convertToNote()TextColumn.convertToNote()TextStyleRange.convertToNote()Word.convertToNote()