OneNote.Outline class
Paragraph オブジェクトのコンテナーを表します。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| id | Outline オブジェクトの ID を取得します。 読み取り専用です。 |
| page |
Outline を含む PageContent オブジェクトを取得します。 このオブジェクトは、ページ上の Outline の位置を定義します。 読み取り専用です。 |
| paragraphs | Outline に含まれる Paragraph オブジェクトのコレクションを取得します。 読み取り専用です。 |
メソッド
| append |
指定された HTML を Outline の一番下に追加します。 |
| append |
指定されたイメージを Outline の一番下に追加します。 |
| append |
指定されたテキストを Outline の一番下に追加します。 |
| append |
指定された数の行と列を含むテーブルを Outline の一番下に追加します。 |
| is |
アウトラインがタイトルアウトラインかどうかを確認します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは の短縮形です |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは の |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
id
Outline オブジェクトの ID を取得します。 読み取り専用です。
readonly id: string;プロパティ値
string
注釈
pageContent
Outline を含む PageContent オブジェクトを取得します。 このオブジェクトは、ページ上の Outline の位置を定義します。 読み取り専用です。
readonly pageContent: OneNote.PageContent;プロパティ値
注釈
paragraphs
Outline に含まれる Paragraph オブジェクトのコレクションを取得します。 読み取り専用です。
readonly paragraphs: OneNote.ParagraphCollection;プロパティ値
注釈
メソッドの詳細
appendHtml(html)
指定された HTML を Outline の一番下に追加します。
appendHtml(html: string): void;パラメーター
- html
-
string
追加する HTML 文字列です。 OneNote アドイン JavaScript API で サポートされている HTML に関するページを参照してください。
戻り値
void
注釈
例
await OneNote.run(async (context) => {
// Gets the active page.
const activePage = context.application.getActivePage();
// Get pageContents of the activePage.
const pageContents = activePage.contents;
// Queue a command to load the pageContents to access its data.
context.load(pageContents);
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline")
{
// First item is an outline.
const outline = pageContents.items[0].outline;
// Queue a command to append a paragraph to the outline.
outline.appendHtml("<p>new paragraph</p>");
// Run the queued commands.
await context.sync();
}
});
appendImage(base64EncodedImage, width, height)
指定されたイメージを Outline の一番下に追加します。
appendImage(base64EncodedImage: string, width: number, height: number): OneNote.Image;パラメーター
- base64EncodedImage
-
string
追加する HTML 文字列です。
- width
-
number
オプション。 ポイント単位の幅。 既定値は null で、イメージの幅が使用されます。
- height
-
number
オプション。 ポイント単位の高さ。 既定値は null で、イメージの高さが使用されます。
戻り値
注釈
appendRichText(paragraphText)
指定されたテキストを Outline の一番下に追加します。
appendRichText(paragraphText: string): OneNote.RichText;パラメーター
- paragraphText
-
string
追加する HTML 文字列です。
戻り値
注釈
appendTable(rowCount, columnCount, values)
指定された数の行と列を含むテーブルを Outline の一番下に追加します。
appendTable(rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;パラメーター
- rowCount
-
number
必須です。 表の行数。
- columnCount
-
number
必須です。 表の列数。
- values
-
string[][]
省略可能な 2 次元配列。 対応する文字列が配列で指定されている場合、セルに設定されます。
戻り値
注釈
例
await OneNote.run(async (context) => {
// Gets the active page.
const activePage = context.application.getActivePage();
// Get pageContents of the activePage.
const pageContents = activePage.contents;
// Queue a command to load the pageContents to access its data.
context.load(pageContents);
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline") {
// First item is an outline.
const outline = pageContents.items[0].outline;
// Queue a command to append a paragraph to the outline.
outline.appendTable(2, 2, [["1", "2"],["3", "4"]]);
// Run the queued commands.
await context.sync();
}
});
isTitle()
アウトラインがタイトルアウトラインかどうかを確認します。
isTitle(): OfficeExtension.ClientResult<boolean>;戻り値
OfficeExtension.ClientResult<boolean>
注釈
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: OneNote.Interfaces.OutlineLoadOptions): OneNote.Outline;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): OneNote.Outline;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.Outline;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡される オブジェクトの メソッドを呼び出 toJSON します)。元の OneNote.Outline オブジェクトは API オブジェクトですが、メソッドは、元の toJSON オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として OneNote.Interfaces.OutlineData型指定) を返します。
toJSON(): OneNote.Interfaces.OutlineData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは の短縮形です context.trackedObjects.add(thisObject)。 このオブジェクトを呼び出しで .sync 使用し、".run" バッチのシーケンシャル実行の外部で使用していて、プロパティを設定するとき、またはオブジェクトのメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。
track(): OneNote.Outline;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは の context.trackedObjects.remove(thisObject)短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に を呼び出す context.sync() 必要があります。
untrack(): OneNote.Outline;戻り値
Office Add-ins