Note(注釈)のコレクション
| Ver. | プロパティ名 | R/O | 値 | 説明 |
|---|---|---|---|---|
| length | ○ | 数値 | オブジェクト数 |
| Ver. | メソッドの書式 | 戻り値 | メソッドの説明 | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| パラメータ | 値 | パラメータの説明 | |||||||||||||||||||||||||||||||
| add([at], [reference], [withProperties]) | Note | 新しいオブジェクトを作成し、それを返す | |||||||||||||||||||||||||||||||
| [at] |
LocationOptions
| 位置 (既定値=LocationOptions.UNKNOWN) | |||||||||||||||||||||||||||||||
| [reference] | Note, InsertionPoint | 位置の基準になるオブジェクト | |||||||||||||||||||||||||||||||
| [withProperties] | Object | プロパティを設定 | |||||||||||||||||||||||||||||||
| anyItem() | Note | どれかのオブジェクトを返す | |||||||||||||||||||||||||||||||
| count() | 数値 | 要素数を返す | |||||||||||||||||||||||||||||||
| everyItem() | Note (Array) | 全てのオブジェクトを返す | |||||||||||||||||||||||||||||||
| firstItem() | Note | 最初のオブジェクトを返す | |||||||||||||||||||||||||||||||
| item(index) | Note | インデックスまたは名前で指定したオブジェクトを返す | |||||||||||||||||||||||||||||||
| index | 数値, 文字列値 | インデックスまたは名前 | |||||||||||||||||||||||||||||||
| itemByID(id) | Note | IDで指定したオブジェクトを返す | |||||||||||||||||||||||||||||||
| id | 数値 | ||||||||||||||||||||||||||||||||
| itemByName(name) | Note | 名前で指定したオブジェクトを返す | |||||||||||||||||||||||||||||||
| name | 文字列値 | ||||||||||||||||||||||||||||||||
| itemByRange(from, to) | Note (Array) | 範囲で指定したオブジェクトを返す | |||||||||||||||||||||||||||||||
| from | Note, 数値, 文字列値 | 範囲の開始 | |||||||||||||||||||||||||||||||
| to | Note, 数値, 文字列値 | 範囲の終了 | |||||||||||||||||||||||||||||||
| lastItem() | Note | 最後のオブジェクトを返す | |||||||||||||||||||||||||||||||
| middleItem() | Note | 真ん中のオブジェクトを返す | |||||||||||||||||||||||||||||||
| nextItem(obj) | Note | 一つ後のオブジェクトを返す | |||||||||||||||||||||||||||||||
| obj | Note | 位置の基準になるオブジェクト | |||||||||||||||||||||||||||||||
| previousItem(obj) | Note | 一つ前のオブジェクトを返す | |||||||||||||||||||||||||||||||
| obj | Note | 位置の基準になるオブジェクト | |||||||||||||||||||||||||||||||
| toSource() | 文字列値 | ソースコードを表す文字列を返す | |||||||||||||||||||||||||||||||
注釈
| Ver. | プロパティ | R/O | 値 |
|---|---|---|---|
| parent | ○ | XmlStory, Story, TextFrame, EndnoteTextFrame, InsertionPoint, Cell | |
| characters | ○ | Characters | |
| eventListeners | ○ | EventListeners | |
| events | ○ | Events | |
| hiddenTexts | ○ | HiddenTexts | |
| insertionPoints | ○ | InsertionPoints | |
| lines | ○ | Lines | |
| paragraphs | ○ | Paragraphs | |
| textColumns | ○ | TextColumns | |
| texts | ○ | Texts | |
| textStyleRanges | ○ | TextStyleRanges | |
| textVariableInstances | ○ | TextVariableInstances | |
| words | ○ | Words | |
| Ver. | プロパティ名 | R/O | 値 | 説明 |
|---|---|---|---|---|
| collapsed | 真偽値 | 注釈が展開されているかどうか。true:展開表示、false:折り畳み表示 | ||
| creationDate | ○ | 日時値 | 作成日時 | |
| id | ○ | 数値 | オブジェクトのID | |
| index | ○ | 数値 | インデックス | |
| isValid | ○ | 真偽値 | オブジェクトが有効かどうか | |
| label | 文字列値 | スクリプトラベル | ||
| modificationDate | ○ | 日時値 | 修正日時 | |
| name | 文字列値 | オブジェクトの名前 - label のエイリアス | ||
| properties | Object | |||
| storyOffset | ○ | InsertionPoint | ストーリー内の位置 | |
| userName | ○ | 文字列値 | 注釈の作成者 |
| Ver. | メソッドの書式 | 戻り値 | メソッドの説明 | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| パラメータ | 値 | パラメータの説明 | |||||||||||||||||||||||||||||||
| addEventListener(eventType, handler, [captures]) | EventListener | EventListenerを作成 | |||||||||||||||||||||||||||||||
| eventType | 文字列値 | ||||||||||||||||||||||||||||||||
| handler | ファイル, JavaScript関数 | ||||||||||||||||||||||||||||||||
| [captures] | 真偽値 | (廃止) | |||||||||||||||||||||||||||||||
| convertToText() | なし | テキストに変換 | |||||||||||||||||||||||||||||||
| extractLabel(key) | 文字列値 | キーに関連づけられた値を取得 | |||||||||||||||||||||||||||||||
| key | 文字列値 | キー | |||||||||||||||||||||||||||||||
| getElements() | Array( Note ) | オブジェクト参照を返す | |||||||||||||||||||||||||||||||
| insertLabel(key, value) | なし | キーに関連づけられた値を設定 | |||||||||||||||||||||||||||||||
| key | 文字列値 | キー | |||||||||||||||||||||||||||||||
| value | 文字列値 | 値 | |||||||||||||||||||||||||||||||
| move(to, [reference]) | Note | テキストのドラッグ&ドロップ | |||||||||||||||||||||||||||||||
| to |
LocationOptions
| 移動先 | |||||||||||||||||||||||||||||||
| [reference] | Text, Story | 位置の基準になるオブジェクト | |||||||||||||||||||||||||||||||
| remove() | なし | 削除 | |||||||||||||||||||||||||||||||
| removeEventListener(eventType, handler, [captures]) | 真偽値 | EventListenerを削除 | |||||||||||||||||||||||||||||||
| eventType | 文字列値 | ||||||||||||||||||||||||||||||||
| handler | ファイル, JavaScript関数 | ||||||||||||||||||||||||||||||||
| [captures] | 真偽値 | (廃止) | |||||||||||||||||||||||||||||||
| toSource() | 文字列値 | ソースコードを表す文字列を返す | |||||||||||||||||||||||||||||||
| toSpecifier() | 文字列値 | Retrieves the object specifier. | |||||||||||||||||||||||||||||||