Word.TableOfContents class
Word 文書の目次を表します。
- Extends
注釈
使用元
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/42-reference-tables/table-of-contents.yaml
// Gets and logs properties from the first table of contents.
await Word.run(async (context) => {
const tablesOfContents: Word.TableOfContentsCollection = context.document.tablesOfContents;
tablesOfContents.load("items");
await context.sync();
if (tablesOfContents.items.length === 0) {
console.log("No table of contents found. Create one first.");
return;
}
const tableOfContents: Word.TableOfContents = tablesOfContents.items[0];
tableOfContents.load(
"areBuiltInHeadingStylesUsed,arePageNumbersIncluded,arePageNumbersRightAligned,lowerHeadingLevel,range/text,tabLeader,upperHeadingLevel"
);
await context.sync();
console.log("Table of contents:", tableOfContents.range.text);
console.log(
`Heading levels: ${tableOfContents.upperHeadingLevel}-${tableOfContents.lowerHeadingLevel}`
);
console.log(`Uses built-in heading styles: ${tableOfContents.areBuiltInHeadingStylesUsed}`);
console.log(`Includes page numbers: ${tableOfContents.arePageNumbersIncluded}`);
console.log(`Right-aligned page numbers: ${tableOfContents.arePageNumbersRightAligned}`);
console.log(`Tab leader: ${tableOfContents.tabLeader}`);
});
プロパティ
| additional |
目次に使用される追加のスタイルを取得します。 既定の "見出し 1" - "見出し 9" スタイルは、このコレクションには含まれません。 |
| are |
目次に組み込みの見出しスタイルを使用するかどうかを指定します。 |
| are |
目 次エントリ (TC) フィールド を目次に含めるかどうかを指定します。 |
| are |
Web に発行するときに、目次のエントリをハイパーリンクとして書式設定するかどうかを指定します。 |
| are |
Web に発行するときに目次のページ番号を非表示にするかどうかを指定します。 |
| are |
ページ番号を目次に含めるかどうかを指定します。 |
| are |
ページ番号を目次の右余白に合わせるかどうかを指定します。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| lower |
目次の終了見出しレベルを指定します。 1 から 9 までの値で、 |
| range | この目次であるドキュメントの部分を取得します。 |
| tab |
目次内のエントリとそのページ番号の間の文字を指定します。 |
| table |
目次に使用される TC フィールド から 1 文字の識別子を指定します。 |
| upper |
目次の開始見出しレベルを指定します。 1 から 9 までの値で、 |
メソッド
| delete() | この目次を削除します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。 |
| set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
| update |
目次全体をUpdatesします。 |
プロパティの詳細
additionalHeadingStyles
目次に使用される追加のスタイルを取得します。 既定の "見出し 1" - "見出し 9" スタイルは、このコレクションには含まれません。
readonly additionalHeadingStyles: Word.HeadingStyleCollection;プロパティ値
注釈
areBuiltInHeadingStylesUsed
目次に組み込みの見出しスタイルを使用するかどうかを指定します。
areBuiltInHeadingStylesUsed: boolean;プロパティ値
boolean
注釈
areFieldsUsed
areHyperlinksUsedOnWeb
Web に発行するときに、目次のエントリをハイパーリンクとして書式設定するかどうかを指定します。
areHyperlinksUsedOnWeb: boolean;プロパティ値
boolean
注釈
arePageNumbersHiddenOnWeb
Web に発行するときに目次のページ番号を非表示にするかどうかを指定します。
arePageNumbersHiddenOnWeb: boolean;プロパティ値
boolean
注釈
arePageNumbersIncluded
ページ番号を目次に含めるかどうかを指定します。
arePageNumbersIncluded: boolean;プロパティ値
boolean
注釈
arePageNumbersRightAligned
ページ番号を目次の右余白に合わせるかどうかを指定します。
arePageNumbersRightAligned: boolean;プロパティ値
boolean
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/42-reference-tables/table-of-contents.yaml
// Changes the page number alignment and tab leader in the first table of contents.
await Word.run(async (context) => {
const tablesOfContents: Word.TableOfContentsCollection = context.document.tablesOfContents;
tablesOfContents.load("items");
await context.sync();
if (tablesOfContents.items.length === 0) {
console.log("No table of contents found. Create one first.");
return;
}
const tableOfContents: Word.TableOfContents = tablesOfContents.items[0];
tableOfContents.arePageNumbersRightAligned = false;
tableOfContents.tabLeader = Word.TabLeader.dashes;
await context.sync();
console.log("Updated the table of contents properties.");
});
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
lowerHeadingLevel
目次の終了見出しレベルを指定します。 1 から 9 までの値で、 upperHeadingLevel より大きい必要があります。
lowerHeadingLevel: number;プロパティ値
number
注釈
range
この目次であるドキュメントの部分を取得します。
readonly range: Word.Range;プロパティ値
注釈
tabLeader
目次内のエントリとそのページ番号の間の文字を指定します。
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";プロパティ値
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
注釈
tableId
upperHeadingLevel
目次の開始見出しレベルを指定します。 1 から 9 までの値で、 lowerHeadingLevel より小さい必要があります。
upperHeadingLevel: number;プロパティ値
number
注釈
メソッドの詳細
delete()
この目次を削除します。
delete(): void;返品
void
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/42-reference-tables/table-of-contents.yaml
// Deletes the first table of contents.
await Word.run(async (context) => {
const tablesOfContents: Word.TableOfContentsCollection = context.document.tablesOfContents;
tablesOfContents.load("items");
await context.sync();
if (tablesOfContents.items.length === 0) {
console.log("No table of contents found.");
return;
}
const tableOfContents: Word.TableOfContents = tablesOfContents.items[0];
tableOfContents.delete();
await context.sync();
console.log("Deleted the table of contents.");
});
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.TableOfContents;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableOfContents;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.TableOfContentsUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.TableOfContents): void;パラメーター
- properties
- Word.TableOfContents
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.TableOfContents オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.TableOfContentsData と型指定) を返します。
toJSON(): Word.Interfaces.TableOfContentsData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.TableOfContents;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.TableOfContents;返品
updatePageNumbers()
目次全体をUpdatesします。
updatePageNumbers(): void;返品
void
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/42-reference-tables/table-of-contents.yaml
// Updates the page numbers in the first table of contents.
await Word.run(async (context) => {
const tablesOfContents: Word.TableOfContentsCollection = context.document.tablesOfContents;
tablesOfContents.load("items");
await context.sync();
if (tablesOfContents.items.length === 0) {
console.log("No table of contents found. Create one first.");
return;
}
const tableOfContents: Word.TableOfContents = tablesOfContents.items[0];
tableOfContents.updatePageNumbers();
await context.sync();
console.log("Updated the table of contents page numbers.");
});