A note in a story.
Go to Property Listing | Method Listing
addEventListener, convertToText, extractLabel, getElements, insertLabel, move, remove, removeEventListener, toSource, toSpecifier
Boolean, Characters, Date, EventListeners, Events, HiddenTexts, InsertionPoints, Lines, Number, Object, Paragraphs, String, TextColumns, TextStyleRanges, TextVariableInstances, Texts, Words,
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
A collection of characters. |
||
|
read/write |
If true, the note is collapsed in galley view. |
||
|
readonly |
The date and time the note was created. |
||
|
readonly |
A collection of event listeners. |
||
|
readonly |
A collection of events. |
||
|
readonly |
A collection of hidden text objects. |
||
|
readonly |
The unique ID of the Note. |
||
|
readonly |
The index of the Note within its containing object. |
||
|
readonly |
A collection of insertion points. |
||
|
readonly |
Returns true if the object specifier resolves to valid objects. |
||
|
read/write |
A property that can be set to any string. |
||
|
readonly |
A collection of lines. |
||
|
readonly |
The date and time the note was last modified. |
||
|
read/write |
The name of the Note; this is an alias to the Note's label property. |
||
|
readonly |
A collection of paragraphs. |
||
|
readonly |
The parent of the Note (a XmlStory, Story, TextFrame, EndnoteTextFrame, InsertionPoint or Cell). |
||
|
read/write |
A property that allows setting of several properties at the same time. |
||
|
readonly |
The insertion point before the table in the story containing the table. |
||
|
readonly |
A collection of text columns. |
||
|
readonly |
A collection of text style ranges. |
||
|
readonly |
A collection of text variable instances. |
||
|
readonly |
A collection of text objects. |
||
|
readonly |
The user who made the note. |
||
|
readonly |
A collection of words. |
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The event type. |
|
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
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 |
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.
Note move (to:LocationOptions, reference:Varies Text Story)
Moves the note to the specified location.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
The new location relative to the reference object or within the containing object. |
|
|
reference |
The reference object. Note: Required when the to parameter specifies before or after. Can accept: Text or Story. (Optional) |
undefined remove ()
Deletes the Note.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
|
Parameter |
Type |
Description |
|---|---|---|
|
eventType |
The registered event type. |
|
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
|
captures |
This parameter is obsolete. (Optional) (default: false) |
String toSource ()
Generates a string which, if executed, will return the Note.
String toSpecifier ()
Retrieves the object specifier.
Character.parent
Event.parent
EventListener.parent
HiddenText.parent
InsertionPoint.parent
Line.parent
MutationEvent.parent
Paragraph.parent
Text.parent
TextColumn.parent
TextStyleRange.parent
TextVariableInstance.parent
Word.parent