word package
クラス
Word.Application |
アプリケーション オブジェクトを表します。 |
Word.Body |
文書またはセクションの本文を表します。 |
Word.Comment |
ドキュメント内のコメントを表します。 |
Word.CommentCollection |
Word.Comment オブジェクトのコレクションを格納します。 |
Word.CommentContentRange | |
Word.CommentReply |
ドキュメント内のコメント応答を表します。 |
Word.CommentReplyCollection |
Word.CommentReply オブジェクトのコレクションを格納します。 1 つのコメント スレッド内のすべてのコメント応答を表します。 |
Word.ContentControl |
コンテンツ コントロールを表します。 コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能し、ドキュメント内で境界線で区切られ、ラベルが付いた領域になる場合もあります。 個々のコンテンツ コントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。 現時点では、リッチ テキストとプレーン テキスト コンテンツ コントロールのみがサポートされています。 |
Word.ContentControlCollection |
Word.ContentControl オブジェクトのコレクションを格納します。 コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能する、ラベルを付けることのできる、境界線で区切られたドキュメント内の領域です。 個々のコンテンツ コントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。 現時点では、リッチ テキストとプレーン テキスト コンテンツ コントロールのみがサポートされています。 |
Word.CustomProperty |
カスタム プロパティを表します。 |
Word.CustomPropertyCollection |
Word.CustomProperty オブジェクトのコレクションを格納します。 |
Word.CustomXmlPart |
カスタム XML パーツを表します。 |
Word.CustomXmlPartCollection |
Word.CustomXmlPart オブジェクトのコレクションを格納します。 |
Word.CustomXmlPartScopedCollection |
特定の名前空間を持つ Word.CustomXmlPart オブジェクトのコレクションを格納します。 |
Word.Document |
Document オブジェクトは、最上位レベルのオブジェクトです。 ドキュメント オブジェクトには、1 つ以上のセクション、コンテンツ コントロール、ドキュメントの内容を含む本文が含まれています。 |
Word.DocumentCreated |
DocumentCreated オブジェクトは、Application.CreateDocument によって作成された最上位のオブジェクトです。 DocumentCreated オブジェクトは、特殊な Document オブジェクトです。 |
Word.DocumentProperties |
ドキュメント プロパティを表します。 |
Word.Field |
フィールドを表します。 |
Word.FieldCollection |
Word.Field オブジェクトのコレクションを格納します。 |
Word.Font |
フォントを表します。 |
Word.InlinePicture |
インライン画像を表します。 |
Word.InlinePictureCollection |
Word.InlinePicture オブジェクトのコレクションを格納します。 |
Word.List |
Word.Paragraph オブジェクトのコレクションを格納します。 |
Word.ListCollection |
Word.List オブジェクトのコレクションを格納します。 |
Word.ListItem |
段落リスト アイテムの形式を表します。 |
Word.ListLevel |
リスト レベルを表します。 |
Word.ListLevelCollection |
Word.ListLevel オブジェクトのコレクションを格納します。 |
Word.ListTemplate |
ListTemplate を表します。 |
Word.NoteItem |
脚注または文末脚注を表します。 |
Word.NoteItemCollection |
Word.NoteItem オブジェクトのコレクションを格納します。 |
Word.Paragraph |
選択部分、範囲、コンテンツ コントロール、または文書本文に含まれる 1 つの段落を表します。 |
Word.ParagraphCollection |
Word.Paragraph オブジェクトのコレクションを格納します。 |
Word.ParagraphFormat |
ドキュメント内の段落のスタイルを表します。 |
Word.Range |
文書内の連続した領域を表します。 |
Word.RangeCollection |
Word.Range オブジェクトのコレクションを格納します。 |
Word.RequestContext |
RequestContext オブジェクトは、Word アプリケーションへの要求を容易にします。 Office アドインと Word アプリケーションは 2 つの異なるプロセスで実行されるため、アドインから Word オブジェクト モデルにアクセスするには、要求コンテキストが必要です。 |
Word.SearchOptions |
検索操作に含めるオプションを指定します。 Word JavaScript API で検索オプションを使用する方法の詳細については、「 検索オプションを使用して Word アドインのテキストを検索する」を参照してください。 |
Word.Section |
Word 文書内のセクションを表します。 |
Word.SectionCollection |
文書の Word.Section オブジェクトのコレクションを格納します。 |
Word.Setting |
アドインの設定を表します。 |
Word.SettingCollection |
Word.Setting オブジェクトのコレクションを格納します。 |
Word.Style |
Word 文書のスタイルを表します。 |
Word.StyleCollection |
Word.Style オブジェクトのコレクションを格納します。 |
Word.Table |
Word 文書内のテーブルを表します。 |
Word.TableBorder |
境界のスタイルを指定します。 |
Word.TableCell |
Word 文書の表のセルを表します。 |
Word.TableCellCollection |
ドキュメントの TableCell オブジェクトのコレクションを格納します。 |
Word.TableCollection |
ドキュメントの Table オブジェクトのコレクションを格納します。 |
Word.TableRow |
Word 文書の行を表します。 |
Word.TableRowCollection |
ドキュメントの TableRow オブジェクトのコレクションを格納します。 |
インターフェイス
Word.CommentDetail |
このコメントの ID と応答 ID の構造体。 |
Word.CommentEventArgs |
コメント イベントを発生させたコメントに関する情報を提供します。 |
Word.ContentControlEventArgs |
イベントを発生させたコンテンツ コントロールに関する情報を提供します。 |
Word.ContentControlOptions |
返されるコンテンツ コントロールを定義するオプションを指定します。 |
Word.InsertFileOptions |
ファイルを挿入するときにコピーする内容を決定するオプションを指定します。 |
Word.Interfaces.BodyData |
を呼び出 |
Word.Interfaces.BodyLoadOptions |
文書またはセクションの本文を表します。 |
Word.Interfaces.BodyUpdateData |
で使用 |
Word.Interfaces.CollectionLoadOptions |
コレクションのメンバーのサブセットのみのプロパティを読み込む方法を提供します。 |
Word.Interfaces.CommentCollectionData |
を呼び出 |
Word.Interfaces.CommentCollectionLoadOptions |
Word.Comment オブジェクトのコレクションを格納します。 |
Word.Interfaces.CommentCollectionUpdateData |
で使用 |
Word.Interfaces.CommentContentRangeData |
を呼び出 |
Word.Interfaces.CommentContentRangeLoadOptions | |
Word.Interfaces.CommentContentRangeUpdateData |
で使用 |
Word.Interfaces.CommentData |
を呼び出 |
Word.Interfaces.CommentLoadOptions |
ドキュメント内のコメントを表します。 |
Word.Interfaces.CommentReplyCollectionData |
を呼び出 |
Word.Interfaces.CommentReplyCollectionLoadOptions |
Word.CommentReply オブジェクトのコレクションを格納します。 1 つのコメント スレッド内のすべてのコメント応答を表します。 |
Word.Interfaces.CommentReplyCollectionUpdateData |
で使用 |
Word.Interfaces.CommentReplyData |
を呼び出 |
Word.Interfaces.CommentReplyLoadOptions |
ドキュメント内のコメント応答を表します。 |
Word.Interfaces.CommentReplyUpdateData |
で使用 |
Word.Interfaces.CommentUpdateData |
で使用 |
Word.Interfaces.ContentControlCollectionData |
を呼び出 |
Word.Interfaces.ContentControlCollectionLoadOptions |
Word.ContentControl オブジェクトのコレクションを格納します。 コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能する、ラベルを付けることのできる、境界線で区切られたドキュメント内の領域です。 個々のコンテンツ コントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。 現時点では、リッチ テキストとプレーン テキスト コンテンツ コントロールのみがサポートされています。 |
Word.Interfaces.ContentControlCollectionUpdateData |
で使用 |
Word.Interfaces.ContentControlData |
を呼び出 |
Word.Interfaces.ContentControlLoadOptions |
コンテンツ コントロールを表します。 コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能し、ドキュメント内で境界線で区切られ、ラベルが付いた領域になる場合もあります。 個々のコンテンツ コントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。 現時点では、リッチ テキストとプレーン テキスト コンテンツ コントロールのみがサポートされています。 |
Word.Interfaces.ContentControlUpdateData |
で使用 |
Word.Interfaces.CustomPropertyCollectionData |
を呼び出 |
Word.Interfaces.CustomPropertyCollectionLoadOptions |
Word.CustomProperty オブジェクトのコレクションを格納します。 |
Word.Interfaces.CustomPropertyCollectionUpdateData |
で使用する CustomPropertyCollection オブジェクトの |
Word.Interfaces.CustomPropertyData |
を呼び出 |
Word.Interfaces.CustomPropertyLoadOptions |
カスタム プロパティを表します。 |
Word.Interfaces.CustomPropertyUpdateData |
で使用 |
Word.Interfaces.CustomXmlPartCollectionData |
を呼び出 |
Word.Interfaces.CustomXmlPartCollectionLoadOptions |
Word.CustomXmlPart オブジェクトのコレクションを格納します。 |
Word.Interfaces.CustomXmlPartCollectionUpdateData |
で使用 |
Word.Interfaces.CustomXmlPartData |
を呼び出 |
Word.Interfaces.CustomXmlPartLoadOptions |
カスタム XML パーツを表します。 |
Word.Interfaces.CustomXmlPartScopedCollectionData |
を呼び出 |
Word.Interfaces.CustomXmlPartScopedCollectionLoadOptions |
特定の名前空間を持つ Word.CustomXmlPart オブジェクトのコレクションを格納します。 |
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData |
で使用する CustomXmlPartScopedCollection オブジェクトの |
Word.Interfaces.DocumentCreatedData |
を呼び出 |
Word.Interfaces.DocumentCreatedLoadOptions |
DocumentCreated オブジェクトは、Application.CreateDocument によって作成された最上位のオブジェクトです。 DocumentCreated オブジェクトは、特殊な Document オブジェクトです。 |
Word.Interfaces.DocumentCreatedUpdateData |
で使用 |
Word.Interfaces.DocumentData |
を呼び出 |
Word.Interfaces.DocumentLoadOptions |
Document オブジェクトは、最上位レベルのオブジェクトです。 ドキュメント オブジェクトには、1 つ以上のセクション、コンテンツ コントロール、ドキュメントの内容を含む本文が含まれています。 |
Word.Interfaces.DocumentPropertiesData |
を呼び出 |
Word.Interfaces.DocumentPropertiesLoadOptions |
ドキュメント プロパティを表します。 |
Word.Interfaces.DocumentPropertiesUpdateData |
で使用 |
Word.Interfaces.DocumentUpdateData |
で使用 |
Word.Interfaces.FieldCollectionData |
を呼び出 |
Word.Interfaces.FieldCollectionLoadOptions |
Word.Field オブジェクトのコレクションを格納します。 |
Word.Interfaces.FieldCollectionUpdateData |
で使用 |
Word.Interfaces.FieldData |
を呼び出 |
Word.Interfaces.FieldLoadOptions |
フィールドを表します。 |
Word.Interfaces.FieldUpdateData |
で使用 |
Word.Interfaces.FontData |
を呼び出 |
Word.Interfaces.FontLoadOptions |
フォントを表します。 |
Word.Interfaces.FontUpdateData |
で使用 |
Word.Interfaces.InlinePictureCollectionData |
を呼び出 |
Word.Interfaces.InlinePictureCollectionLoadOptions |
Word.InlinePicture オブジェクトのコレクションを格納します。 |
Word.Interfaces.InlinePictureCollectionUpdateData |
で使用 |
Word.Interfaces.InlinePictureData |
を呼び出 |
Word.Interfaces.InlinePictureLoadOptions |
インライン画像を表します。 |
Word.Interfaces.InlinePictureUpdateData |
で使用 |
Word.Interfaces.ListCollectionData |
を呼び出 |
Word.Interfaces.ListCollectionLoadOptions |
Word.List オブジェクトのコレクションを格納します。 |
Word.Interfaces.ListCollectionUpdateData |
で使用 |
Word.Interfaces.ListData |
を呼び出 |
Word.Interfaces.ListItemData |
を呼び出 |
Word.Interfaces.ListItemLoadOptions |
段落リスト アイテムの形式を表します。 |
Word.Interfaces.ListItemUpdateData |
で使用 |
Word.Interfaces.ListLevelCollectionData |
を呼び出 |
Word.Interfaces.ListLevelCollectionLoadOptions |
Word.ListLevel オブジェクトのコレクションを格納します。 |
Word.Interfaces.ListLevelCollectionUpdateData |
で使用 |
Word.Interfaces.ListLevelData |
を呼び出 |
Word.Interfaces.ListLevelLoadOptions |
リスト レベルを表します。 |
Word.Interfaces.ListLevelUpdateData |
で使用 |
Word.Interfaces.ListLoadOptions |
Word.Paragraph オブジェクトのコレクションを格納します。 |
Word.Interfaces.ListTemplateData |
を呼び出 |
Word.Interfaces.ListTemplateLoadOptions |
ListTemplate を表します。 |
Word.Interfaces.ListTemplateUpdateData |
で使用 |
Word.Interfaces.NoteItemCollectionData |
を呼び出 |
Word.Interfaces.NoteItemCollectionLoadOptions |
Word.NoteItem オブジェクトのコレクションを格納します。 |
Word.Interfaces.NoteItemCollectionUpdateData |
で使用 |
Word.Interfaces.NoteItemData |
を呼び出 |
Word.Interfaces.NoteItemLoadOptions |
脚注または文末脚注を表します。 |
Word.Interfaces.NoteItemUpdateData |
で使用 |
Word.Interfaces.ParagraphCollectionData |
を呼び出 |
Word.Interfaces.ParagraphCollectionLoadOptions |
Word.Paragraph オブジェクトのコレクションを格納します。 |
Word.Interfaces.ParagraphCollectionUpdateData |
で使用 |
Word.Interfaces.ParagraphData |
を呼び出 |
Word.Interfaces.ParagraphFormatData |
を呼び出 |
Word.Interfaces.ParagraphFormatLoadOptions |
ドキュメント内の段落のスタイルを表します。 |
Word.Interfaces.ParagraphFormatUpdateData |
で使用 |
Word.Interfaces.ParagraphLoadOptions |
選択部分、範囲、コンテンツ コントロール、または文書本文に含まれる 1 つの段落を表します。 |
Word.Interfaces.ParagraphUpdateData |
で使用 |
Word.Interfaces.RangeCollectionData |
を呼び出 |
Word.Interfaces.RangeCollectionLoadOptions |
Word.Range オブジェクトのコレクションを格納します。 |
Word.Interfaces.RangeCollectionUpdateData |
で使用 |
Word.Interfaces.RangeData |
を呼び出 |
Word.Interfaces.RangeLoadOptions |
文書内の連続した領域を表します。 |
Word.Interfaces.RangeUpdateData |
で使用 |
Word.Interfaces.SearchOptionsData |
を呼び出 |
Word.Interfaces.SearchOptionsLoadOptions |
検索操作に含めるオプションを指定します。 Word JavaScript API で検索オプションを使用する方法の詳細については、「 検索オプションを使用して Word アドインのテキストを検索する」を参照してください。 |
Word.Interfaces.SearchOptionsUpdateData |
で使用 |
Word.Interfaces.SectionCollectionData |
を呼び出 |
Word.Interfaces.SectionCollectionLoadOptions |
文書の Word.Section オブジェクトのコレクションを格納します。 |
Word.Interfaces.SectionCollectionUpdateData |
で使用 |
Word.Interfaces.SectionData |
を呼び出 |
Word.Interfaces.SectionLoadOptions |
Word 文書内のセクションを表します。 |
Word.Interfaces.SectionUpdateData |
で使用 |
Word.Interfaces.SettingCollectionData |
を呼び出 |
Word.Interfaces.SettingCollectionLoadOptions |
Word.Setting オブジェクトのコレクションを格納します。 |
Word.Interfaces.SettingCollectionUpdateData |
で使用 |
Word.Interfaces.SettingData |
を呼び出 |
Word.Interfaces.SettingLoadOptions |
アドインの設定を表します。 |
Word.Interfaces.SettingUpdateData |
で使用 |
Word.Interfaces.StyleCollectionData |
を呼び出 |
Word.Interfaces.StyleCollectionLoadOptions |
Word.Style オブジェクトのコレクションを格納します。 |
Word.Interfaces.StyleCollectionUpdateData |
で使用 |
Word.Interfaces.StyleData |
を呼び出 |
Word.Interfaces.StyleLoadOptions |
Word 文書のスタイルを表します。 |
Word.Interfaces.StyleUpdateData |
で使用 |
Word.Interfaces.TableBorderData |
を呼び出 |
Word.Interfaces.TableBorderLoadOptions |
境界のスタイルを指定します。 |
Word.Interfaces.TableBorderUpdateData |
で使用 |
Word.Interfaces.TableCellCollectionData |
を呼び出 |
Word.Interfaces.TableCellCollectionLoadOptions |
ドキュメントの TableCell オブジェクトのコレクションを格納します。 |
Word.Interfaces.TableCellCollectionUpdateData |
で使用 |
Word.Interfaces.TableCellData |
を呼び出 |
Word.Interfaces.TableCellLoadOptions |
Word 文書の表のセルを表します。 |
Word.Interfaces.TableCellUpdateData |
で使用 |
Word.Interfaces.TableCollectionData |
を呼び出 |
Word.Interfaces.TableCollectionLoadOptions |
ドキュメントの Table オブジェクトのコレクションを格納します。 |
Word.Interfaces.TableCollectionUpdateData |
で使用 |
Word.Interfaces.TableData |
を呼び出 |
Word.Interfaces.TableLoadOptions |
Word 文書内のテーブルを表します。 |
Word.Interfaces.TableRowCollectionData |
を呼び出 |
Word.Interfaces.TableRowCollectionLoadOptions |
ドキュメントの TableRow オブジェクトのコレクションを格納します。 |
Word.Interfaces.TableRowCollectionUpdateData |
で使用 |
Word.Interfaces.TableRowData |
を呼び出 |
Word.Interfaces.TableRowLoadOptions |
Word 文書の行を表します。 |
Word.Interfaces.TableRowUpdateData |
で使用 |
Word.Interfaces.TableUpdateData |
で使用 |
列挙型
機能
Word. |
以前に作成した API オブジェクトの RequestContext を使用して、Word オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 |
Word. |
以前に作成した API オブジェクトの RequestContext を使用して、Word オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 promise が解決されると、実行中に自動的に割り当てられた追跡対象オブジェクトが解放されます。 |
Word. |
新しい RequestContext を使用して、Word オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 promise が解決されると、実行中に自動的に割り当てられた追跡対象オブジェクトが解放されます。 |
関数の詳細
Word.run(objects, batch)
以前に作成した API オブジェクトの RequestContext を使用して、Word オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。
export function run<T>(objects: OfficeExtension.ClientObject[], batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
パラメーター
- objects
以前に作成した API オブジェクトの配列。 配列は、すべてのオブジェクトが同じコンテキストを共有することを確認するために検証されます。 バッチでは、この共有 RequestContext が使用されます。これは、これらのオブジェクトに適用された変更が "context.sync()" によって取得されることを意味します。
- batch
-
(context: Word.RequestContext) => Promise<T>
RequestContext を受け取り、promise を返す関数 (通常は "context.sync()" の結果のみ)。 context パラメーターを使用すると、Word アプリケーションへの要求が容易になります。 Office アドインと Word アプリケーションは 2 つの異なるプロセスで実行されるため、アドインから Word オブジェクト モデルにアクセスするには RequestContext が必要です。
戻り値
Promise<T>
Word.run(object, batch)
以前に作成した API オブジェクトの RequestContext を使用して、Word オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 promise が解決されると、実行中に自動的に割り当てられた追跡対象オブジェクトが解放されます。
export function run<T>(object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
パラメーター
- object
- OfficeExtension.ClientObject
以前に作成した API オブジェクト。 バッチでは、渡されたオブジェクトと同じ RequestContext が使用されます。つまり、オブジェクトに適用された変更はすべて "context.sync()" によって取得されます。
- batch
-
(context: Word.RequestContext) => Promise<T>
RequestContext を受け取り、promise を返す関数 (通常は "context.sync()" の結果のみ)。 context パラメーターを使用すると、Word アプリケーションへの要求が容易になります。 Office アドインと Word アプリケーションは 2 つの異なるプロセスで実行されるため、アドインから Word オブジェクト モデルにアクセスするには RequestContext が必要です。
戻り値
Promise<T>
Word.run(batch)
新しい RequestContext を使用して、Word オブジェクト モデルに対してアクションを実行するバッチ スクリプトを実行します。 promise が解決されると、実行中に自動的に割り当てられた追跡対象オブジェクトが解放されます。
export function run<T>(batch: (context: Word.RequestContext) => Promise<T>): Promise<T>;
パラメーター
- batch
-
(context: Word.RequestContext) => Promise<T>
RequestContext を受け取り、promise を返す関数 (通常は "context.sync()" の結果のみ)。 context パラメーターを使用すると、Word アプリケーションへの要求が容易になります。 Office アドインと Word アプリケーションは 2 つの異なるプロセスで実行されるため、アドインから Word オブジェクト モデルにアクセスするには RequestContext が必要です。
戻り値
Promise<T>
フィードバック
フィードバックの送信と表示