OneNote.ParagraphCollection class
Paragraph オブジェクトのコレクションを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| count | ページ内の段落の数を返します。 |
| items | このコレクション内に読み込まれた子アイテムを取得します。 |
メソッド
| get |
ID やコレクション内のインデックスで、Paragraph オブジェクトを取得します。 読み取り専用です。 |
| get |
コレクション内での位置を基に段落を取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
count
items
メソッドの詳細
getItem(index)
ID やコレクション内のインデックスで、Paragraph オブジェクトを取得します。 読み取り専用です。
getItem(index: number | string): OneNote.Paragraph;パラメーター
- index
-
number | string
Paragraph オブジェクト の ID、またはコレクション内の Paragraph オブジェクトのインデックスの場所です。
戻り値
注釈
getItemAt(index)
コレクション内での位置を基に段落を取得します。
getItemAt(index: number): OneNote.Paragraph;パラメーター
- index
-
number
取得するオブジェクトのインデックス値。 0 を起点とする番号になります。
戻り値
注釈
例
await OneNote.run(async (context) => {
// Get the collection of pageContent items from the page.
const pageContents = context.application.getActivePage().contents;
// Get the first PageContent on the page, and then get its Outline's first paragraph.
const pageContent = pageContents.getItemAt(0);
const paragraphs = pageContent.outline.paragraphs;
const firstParagraph = paragraphs.getItemAt(0);
// Queue a command to load the id and type properties of this paragraph.
firstParagraph.load("id,type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Write text from paragraph to console.
console.log(
"First Paragraph found with id : " +
firstParagraph.id + " and type " + firstParagraph.type);
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: OneNote.Interfaces.ParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.ParagraphCollection;パラメーター
- options
-
OneNote.Interfaces.ParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): OneNote.ParagraphCollection;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
例
await OneNote.run(async (context) => {
// Get the collection of pageContent items from the page.
const pageContents = context.application.getActivePage().contents;
// Get the first PageContent on the page, and then get its Outline's first paragraph.
const pageContent = pageContents.getItem(0);
const paragraphs = pageContent.outline.paragraphs;
// Queue a command to load the id and type of each paragraph.
paragraphs.load("id,type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
const firstParagraph = paragraphs.items[0];
// Write text from first paragraph to console.
console.log(
"First Paragraph found with id : " +
firstParagraph.id + " and type " + firstParagraph.type);
});
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.ParagraphCollection;パラメーター
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の OneNote.ParagraphCollection オブジェクトは API オブジェクトですが、 toJSON メソッドは、コレクションの項目から読み込まれたプロパティの浅いコピーを含む "items" 配列を含むプレーンな JavaScript オブジェクト ( OneNote.Interfaces.ParagraphCollectionDataとして型指定) を返します。
toJSON(): OneNote.Interfaces.ParagraphCollectionData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。
track(): OneNote.ParagraphCollection;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。
untrack(): OneNote.ParagraphCollection;戻り値
Office Add-ins