OneNote.PageContent class
Outline や Image などの最上位のコンテンツの種類を含むページの領域を表します。 PageContent オブジェクトは、XY の位置を指定できます。
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| id | PageContent オブジェクトの ID を取得します。 |
| image | PageContent オブジェクト内の Image を取得します。 PageContentType が Image ではない場合は例外をスローします。 |
| ink | PageContent オブジェクト内の Ink を取得します。 PageContentType が Ink ではない場合は例外をスローします。 |
| left | PageContent オブジェクトの左 (X 軸) の位置を取得するか設定します。 |
| outline | PageContent オブジェクト内の Outline を取得します。 PageContentType が Outline ではない場合は例外をスローします。 |
| parent |
PageContent オブジェクトを含むページを取得します。 |
| top | PageContent オブジェクトの上 (Y 軸) の位置を取得するか設定します。 |
| type | PageContent オブジェクトの種類を取得します。 |
メソッド
| delete() | PageContent オブジェクトを削除します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
id
image
PageContent オブジェクト内の Image を取得します。 PageContentType が Image ではない場合は例外をスローします。
readonly image: OneNote.Image;プロパティ値
注釈
ink
PageContent オブジェクト内の Ink を取得します。 PageContentType が Ink ではない場合は例外をスローします。
readonly ink: OneNote.FloatingInk;プロパティ値
注釈
left
PageContent オブジェクトの左 (X 軸) の位置を取得するか設定します。
left: number;プロパティ値
number
注釈
outline
PageContent オブジェクト内の Outline を取得します。 PageContentType が Outline ではない場合は例外をスローします。
readonly outline: OneNote.Outline;プロパティ値
注釈
parentPage
PageContent オブジェクトを含むページを取得します。
readonly parentPage: OneNote.Page;プロパティ値
注釈
top
PageContent オブジェクトの上 (Y 軸) の位置を取得するか設定します。
top: number;プロパティ値
number
注釈
type
PageContent オブジェクトの種類を取得します。
readonly type: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";プロパティ値
OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"
注釈
メソッドの詳細
delete()
PageContent オブジェクトを削除します。
delete(): void;戻り値
void
注釈
例
await OneNote.run(async (context) => {
const page = context.application.getActivePage();
const pageContents = page.contents;
const firstPageContent = pageContents.getItemAt(0);
firstPageContent.load('type');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (firstPageContent.isNullObject === false) {
firstPageContent.delete();
await context.sync();
}
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: OneNote.Interfaces.PageContentLoadOptions): OneNote.PageContent;パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): OneNote.PageContent;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.PageContent;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.PageContentUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- OneNote.Interfaces.PageContentUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: OneNote.PageContent): void;パラメーター
- properties
- OneNote.PageContent
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の OneNote.PageContent オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( OneNote.Interfaces.PageContentData として型指定) を返します。
toJSON(): OneNote.Interfaces.PageContentData;戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync 呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。
track(): OneNote.PageContent;戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync() を呼び出す必要があります。
untrack(): OneNote.PageContent;戻り値
Office Add-ins