Note
QuickLinks
Hierarchy
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. |
| 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. |
| paragraphs | Paragraphs | readonly | A collection of paragraphs. |
| parent | CellInsertionPoint 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
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:
any])
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.
string toSource ()
Generates a string which, if executed, will return the Note.
string toSpecifier ()
Retrieves the object specifier.
Element of
Character.parent
InsertionPoint.parent
Line.parent
Paragraph.parent
Text.parent
TextColumn.parent
TextStyleRange.parent
Word.parent
Used in:
Footnote Footnotes.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Note Notes.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
array of Note Notes.itemByRange (from: any, to: any)
Note Notes.nextItem (obj: Note)
Note Notes.previousItem (obj: Note)
TextVariableInstance TextVariableInstances.add ([to: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Return
Note Character.convertToNote ()
Note InsertionPoint.convertToNote ()
Note Line.convertToNote ()
Array of Note Note.getElements ()
Note Note.move (to: LocationOptions[, reference: any])
Note Notes.[] (index: number)
Note Notes.add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: any][, withProperties: Object])
Note Notes.anyItem ()
Array of Note Notes.everyItem ()
Note Notes.firstItem ()
Note Notes.item (index: any)
Note Notes.itemByID (id: number)
Note Notes.itemByName (name: string)
Array of Note Notes.itemByRange (from: any, to: any)
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, 20-Jun-2010 v3.0.3d | Contents :: Index |