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

InDesign Server CS5

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
Character | Event | EventListener | HiddenText | InsertionPoint | Line | MutationEvent | Paragraph | Text | TextColumn | TextStyleRange | TextVariableInstance | Word

Properties

PropertyTypeAccessDescription
charactersCharacters readonlyA collection of characters.
collapsedbool r/wIf true, the note is collapsed in galley view.
creationDateDate readonlyThe date and time the note was created.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
hiddenTextsHiddenTexts readonlyA collection of hidden text objects.
idnumber readonlyThe unique ID of the Note.
indexnumber readonlyThe index of the Note within its containing object.
insertionPointsInsertionPoints readonlyA collection of insertion points.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
linesLines readonlyA collection of lines.
modificationDateDate readonlyThe date and time the note was last modified.
namestring r/wThe name of the Note; this is an alias to the Note's label property.
paragraphsParagraphs readonlyA collection of paragraphs.
parentCellInsertionPoint
Story
TextFrame
XmlStory
readonlyThe parent of the Note (a XmlStory, Story, TextFrame, InsertionPoint or Cell).
propertiesObject r/wA property that allows setting of several properties at the same time.
storyOffsetInsertionPoint readonlyThe insertion point before the table in the story containing the table.
textColumnsTextColumns readonlyA collection of text columns.
textStyleRangesTextStyleRanges readonlyA collection of text style ranges.
textVariableInstancesTextVariableInstances readonlyA collection of text variable instances.
textsTexts readonlyA collection of text objects.
userNamestring readonlyThe user who made the note.
wordsWords readonlyA collection of words.

Methods

Instances

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

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis 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.

ParameterTypeDescription
keystringThe 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

Note move (to: LocationOptions[, reference: varies])
Moves the note to the specified location.

ParameterTypeDescription
toLocationOptions:
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.
referenceStory
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.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

Note Notes.nextItem (obj: Note)

Note Notes.previousItem (obj: Note)

Return

Note Character.convertToNote ()

Note InsertionPoint.convertToNote ()

Note Line.convertToNote ()

Array of Note Note.getElements ()

Note Note.move (to: LocationOptions[, reference: varies])

Note Notes.[] (index: number)

Note Notes.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])

Note Notes.anyItem ()

Array of Note Notes.everyItem ()

Note Notes.firstItem ()

Note Notes.item (index: varies)

Note Notes.itemByID (id: number)

Note Notes.itemByName (name: string)

Array of Note Notes.itemByRange (from: varies, to: varies)

Note Notes.lastItem ()

Note Notes.middleItem ()

Note Notes.nextItem (obj: Note)

Note Notes.previousItem (obj: Note)

Note Paragraph.convertToNote ()

Note Text.convertToNote ()

Note TextColumn.convertToNote ()

Note TextStyleRange.convertToNote ()

Note Word.convertToNote ()

Jongware, 23-Mar-2011 v3.0.3dContents :: Index