Adobe InDesign CS5 Server (7.0) Object Model JS: Note

InDesign Server CS5

previous page next page

Class

Note

A note in a story.

QuickLinks

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

Hierarchy

Cell | InsertionPoint | Story | TextFrame | XmlStory

Note

Properties

Property	Type	Access	Description
characters	Characters	readonly	A collection of characters.
collapsed	bool	r/w	If true, the note is collapsed in galley view.
creationDate	Date	readonly	The date and time the note was created.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
hiddenTexts	HiddenTexts	readonly	A collection of hidden text objects.
id	number	readonly	The unique ID of the Note.
index	number	readonly	The index of the Note within its containing object.
insertionPoints	InsertionPoints	readonly	A collection of insertion points.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
label	string	r/w	A property that can be set to any string.
lines	Lines	readonly	A collection of lines.
modificationDate	Date	readonly	The date and time the note was last modified.
name	string	r/w	The name of the Note; this is an alias to the Note's label property.
paragraphs	Paragraphs	readonly	A collection of paragraphs.
parent	Cell InsertionPoint Story TextFrame XmlStory	readonly	The parent of the Note (a XmlStory, Story, TextFrame, InsertionPoint or Cell).
properties	Object	r/w	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	readonly	A collection of text columns.
textStyleRanges	TextStyleRanges	readonly	A collection of text style ranges.
textVariableInstances	TextVariableInstances	readonly	A collection of text variable instances.
texts	Texts	readonly	A collection of text objects.
userName	string	readonly	The user who made the note.
words	Words	readonly	A collection of words.

Methods

Instances

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

Parameter	Type	Description
eventType	string	The event type.
handler	File JavaScript Function	The event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)

void 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.

Array of Note getElements ()
Resolves the object specifier, creating an array of object references.

void 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])
Moves the note to the specified location.

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

void remove ()
Deletes the Note.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

Parameter	Type	Description
eventType	string	The registered event type.
handler	File JavaScript Function	The registered event handler. Can accept: File or JavaScript Function.
captures	bool	This parameter is obsolete. (Optional) (default: false)