Word.TableOfAuthorities class
Word ドキュメント内の権限の表を表します。
- Extends
プロパティ
| bookmark | 権威テーブルのエントリを収集するブックマークの名前を指定します。 |
| category | 権限のテーブルに含めるエントリのカテゴリを指定します。 値 0 から 16 は、[権限テーブル] ダイアログの [カテゴリ] ボックスに一覧表示されているアイテムに対応します。 Word UI を使用してこれにアクセスする方法については、「権限の表を作成する」を参照してください。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| entry |
最大 5 文字の区切り文字を指定します。 これは、権限のあるエントリのテーブルとそのページ番号の間に表示されます。 |
| is |
エントリ・グループのカテゴリー名を権限のテーブルに表示するかどうかを指定します。 |
| is |
権限のテーブルのエントリを、テーブルの書式設定で表示するかどうかを指定します。 |
| is |
5 ページ以上繰り返される同じ機関への参照を "Passim" に置き換えるかどうかを指定します。 |
| page |
最大 5 文字の区切り文字を指定します。 これは、権限のテーブルの個々のページ参照の間に表示されます。 |
| page |
最大 5 文字の区切り文字を指定します。 これは、権限のテーブルのページ範囲間に表示されます。 |
| range | ドキュメントのこの権限の表である部分を取得します。 |
| sequence |
権限テーブルの シーケンス (SEQ) フィールド ID を指定します。 |
| sequence |
最大 5 文字の区切り文字を指定します。 これは、権限のテーブルのシーケンス番号とページ番号の間に表示されます。 |
| tab |
権限テーブルのエントリとそれに関連付けられたページ番号の間に表示されるリーダー文字を指定します。 |
メソッド
| 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) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
bookmark
category
権限のテーブルに含めるエントリのカテゴリを指定します。 値 0 から 16 は、[権限テーブル] ダイアログの [カテゴリ] ボックスに一覧表示されているアイテムに対応します。 Word UI を使用してこれにアクセスする方法については、「権限の表を作成する」を参照してください。
category: number;プロパティ値
number
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
entrySeparator
最大 5 文字の区切り文字を指定します。 これは、権限のあるエントリのテーブルとそのページ番号の間に表示されます。
entrySeparator: string;プロパティ値
string
注釈
isCategoryHeaderIncluded
エントリ・グループのカテゴリー名を権限のテーブルに表示するかどうかを指定します。
isCategoryHeaderIncluded: boolean;プロパティ値
boolean
注釈
isEntryFormattingKept
権限のテーブルのエントリを、テーブルの書式設定で表示するかどうかを指定します。
isEntryFormattingKept: boolean;プロパティ値
boolean
注釈
isPassimUsed
5 ページ以上繰り返される同じ機関への参照を "Passim" に置き換えるかどうかを指定します。
isPassimUsed: boolean;プロパティ値
boolean
注釈
pageNumberSeparator
最大 5 文字の区切り文字を指定します。 これは、権限のテーブルの個々のページ参照の間に表示されます。
pageNumberSeparator: string;プロパティ値
string
注釈
pageRangeSeparator
最大 5 文字の区切り文字を指定します。 これは、権限のテーブルのページ範囲間に表示されます。
pageRangeSeparator: string;プロパティ値
string
注釈
range
ドキュメントのこの権限の表である部分を取得します。
readonly range: Word.Range;プロパティ値
注釈
sequenceName
sequenceSeparator
最大 5 文字の区切り文字を指定します。 これは、権限のテーブルのシーケンス番号とページ番号の間に表示されます。
sequenceSeparator: string;プロパティ値
string
注釈
tabLeader
権限テーブルのエントリとそれに関連付けられたページ番号の間に表示されるリーダー文字を指定します。
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";プロパティ値
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
注釈
メソッドの詳細
delete()
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
返品
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.TableOfAuthorities;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
返品
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableOfAuthorities;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
返品
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void;パラメーター
- properties
- Word.Interfaces.TableOfAuthoritiesUpdateData
メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
プロパティ オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
返品
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.TableOfAuthorities): void;パラメーター
- properties
- Word.TableOfAuthorities
返品
void
toJSON()
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.TableOfAuthorities オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.TableOfAuthoritiesData と型指定) を返します。
toJSON(): Word.Interfaces.TableOfAuthoritiesData;返品
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.TableOfAuthorities;返品
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.TableOfAuthorities;