OneNote.InkAnalysisParagraphCollection class
InkAnalysisParagraph オブジェクトのコレクションを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| count | ページ内の InkAnalysisParagraph の数を返します。 読み取り専用です。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| get |
ID かコレクション内のインデックスにより、InkAnalysisParagraph オブジェクトを取得します。 読み取り専用です。 |
| get |
コレクション内での位置を基に InkAnalysisParagraph を取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
count
ページ内の InkAnalysisParagraph の数を返します。 読み取り専用です。
readonly count: number;プロパティ値
number
注釈
items
このコレクション内に読み込まれた子アイテムを取得します。
readonly items: OneNote.InkAnalysisParagraph[];プロパティ値
メソッドの詳細
getItem(index)
ID かコレクション内のインデックスにより、InkAnalysisParagraph オブジェクトを取得します。 読み取り専用です。
getItem(index: number | string): OneNote.InkAnalysisParagraph;パラメーター
- index
-
number | string
InkAnalysisParagraph オブジェクトの ID、またはコレクション内の InkAnalysisParagraph オブジェクトのインデックス位置です。
戻り値
注釈
getItemAt(index)
コレクション内での位置を基に InkAnalysisParagraph を取得します。
getItemAt(index: number): OneNote.InkAnalysisParagraph;パラメーター
- index
-
number
取得するオブジェクトのインデックス値。 0 を起点とする番号になります。
戻り値
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.InkAnalysisParagraphCollection;パラメーター
- options
-
OneNote.Interfaces.InkAnalysisParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): OneNote.InkAnalysisParagraphCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.InkAnalysisParagraphCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の OneNote.InkAnalysisParagraphCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( OneNote.Interfaces.InkAnalysisParagraphCollectionDataとして型指定) を返します。
toJSON(): OneNote.Interfaces.InkAnalysisParagraphCollectionData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部で使用していて、プロパティを設定するとき、またはオブジェクトのメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加しておく必要があります。
track(): OneNote.InkAnalysisParagraphCollection;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。
untrack(): OneNote.InkAnalysisParagraphCollection;戻り値
Office Add-ins