word package
クラス
Word.Application |
アプリケーション オブジェクトを表します。 |
Word.Body |
文書またはセクションの本文を表します。 |
Word.Comment |
ドキュメント内のコメントを表します。 |
Word.CommentCollection |
Wordのコレクションを格納します。コメント オブジェクト。 |
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のコレクションを格納します。フィールド オブジェクト。 |
Word.Font |
フォントを表します。 |
Word.InlinePicture |
インライン画像を表します。 |
Word.InlinePictureCollection |
Wordのコレクションを格納します。InlinePicture オブジェクト。 |
Word.List |
Wordのコレクションを格納します。Paragraph オブジェクト。 |
Word.ListCollection |
Wordのコレクションを格納します。オブジェクトを一覧表示します。 |
Word.ListItem |
段落リスト アイテムの形式を表します。 |
Word.NoteItem |
脚注または文末脚注を表します。 |
Word.NoteItemCollection |
Wordのコレクションを格納します。NoteItem オブジェクト。 |
Word.Paragraph |
選択部分、範囲、コンテンツ コントロール、または文書本文に含まれる 1 つの段落を表します。 |
Word.ParagraphCollection |
Wordのコレクションを格納します。Paragraph オブジェクト。 |
Word.ParagraphFormat |
ドキュメント内の段落のスタイルを表します。 |
Word.Range |
文書内の連続した領域を表します。 |
Word.RangeCollection |
Wordのコレクションを格納します。範囲オブジェクト。 |
Word.RequestContext |
RequestContext オブジェクトは、Word アプリケーションへの要求を容易にします。 Office アドインとWord アプリケーションは 2 つの異なるプロセスで実行されるため、アドインからWord オブジェクト モデルにアクセスするには、要求コンテキストが必要です。 |
Word.SearchOptions |
検索操作に含めるオプションを指定します。 Word JavaScript API で検索オプションを使用する方法の詳細については、「検索オプションを使用してWord アドイン内のテキストを検索する」を参照してください。 |
Word.Section |
Word 文書内のセクションを表します。 |
Word.SectionCollection |
ドキュメントのWordのコレクションを格納します。セクション オブジェクト。 |
Word.Setting |
アドインの設定を表します。 |
Word.SettingCollection |
Wordのコレクションを格納します。オブジェクトの設定。 |
Word.Shading |
シェーディング オブジェクトを表します。 |
Word.Style |
Word ドキュメントのスタイルを表します。 |
Word.StyleCollection |
Wordのコレクションを格納します。オブジェクトのスタイルを設定します。 |
Word.Table |
Word ドキュメント内のテーブルを表します。 |
Word.TableBorder |
境界のスタイルを指定します。 |
Word.TableCell |
Word ドキュメント内のテーブル セルを表します。 |
Word.TableCellCollection |
ドキュメントの TableCell オブジェクトのコレクションを格納します。 |
Word.TableCollection |
ドキュメントの Table オブジェクトのコレクションを格納します。 |
Word.TableRow |
Word ドキュメント内の行を表します。 |
Word.TableRowCollection |
ドキュメントの TableRow オブジェクトのコレクションを格納します。 |
Word.TableStyle |
TableStyle オブジェクトを表します。 |
Word.TrackedChange |
Word ドキュメント内の追跡された変更を表します。 |
Word.TrackedChangeCollection |
Wordのコレクションを格納します。TrackedChange オブジェクト。 |
インターフェイス
Word.ContentControlAddedEventArgs |
contentControlAdded イベントを発生させたコンテンツ コントロールに関する情報を提供します。 |
Word.ContentControlDataChangedEventArgs |
contentControlDataChanged イベントを発生させたコンテンツ コントロールに関する情報を提供します。 |
Word.ContentControlDeletedEventArgs |
contentControlDeleted イベントを発生させたコンテンツ コントロールに関する情報を提供します。 |
Word.ContentControlEnteredEventArgs |
contentControlEntered イベントを発生させたコンテンツ コントロールに関する情報を提供します。 |
Word.ContentControlExitedEventArgs |
contentControlExited イベントを発生させたコンテンツ コントロールに関する情報を提供します。 |
Word.ContentControlOptions |
返されるコンテンツ コントロールを定義するオプションを指定します。 |
Word.ContentControlSelectionChangedEventArgs |
contentControlSelectionChanged イベントを発生させたコンテンツ コントロールに関する情報を提供します。 |
Word.InsertFileOptions |
ファイルを挿入するときにコピーする内容を決定するオプションを指定します。 |
Word.Interfaces.AnnotationCollectionData |
|
Word.Interfaces.AnnotationCollectionUpdateData |
|
Word.Interfaces.AnnotationData |
|
Word.Interfaces.BodyData |
|
Word.Interfaces.BodyLoadOptions |
文書またはセクションの本文を表します。 |
Word.Interfaces.BodyUpdateData |
|
Word.Interfaces.BorderCollectionData |
|
Word.Interfaces.BorderCollectionUpdateData |
|
Word.Interfaces.BorderData |
|
Word.Interfaces.BorderUpdateData |
|
Word.Interfaces.CheckboxContentControlData |
|
Word.Interfaces.CheckboxContentControlUpdateData |
|
Word.Interfaces.CollectionLoadOptions |
コレクションのメンバーのサブセットのみのプロパティを読み込む方法を提供します。 |
Word.Interfaces.ComboBoxContentControlData |
|
Word.Interfaces.CommentCollectionData |
|
Word.Interfaces.CommentCollectionLoadOptions |
Wordのコレクションを格納します。コメント オブジェクト。 |
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.ContentControlListItemCollectionData |
|
Word.Interfaces.ContentControlListItemCollectionUpdateData |
|
Word.Interfaces.ContentControlListItemData |
|
Word.Interfaces.ContentControlListItemUpdateData |
|
Word.Interfaces.ContentControlLoadOptions |
コンテンツ コントロールを表します。 コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能し、ドキュメント内で境界線で区切られ、ラベルが付いた領域になる場合もあります。 個々のコンテンツ コントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。 現時点では、リッチ テキスト、プレーン テキスト、およびチェック ボックス コンテンツ コントロールのみがサポートされています。 |
Word.Interfaces.ContentControlUpdateData |
|
Word.Interfaces.CritiqueAnnotationData |
|
Word.Interfaces.CustomPropertyCollectionData |
|
Word.Interfaces.CustomPropertyCollectionLoadOptions |
Wordのコレクションを格納します。CustomProperty オブジェクト。 |
Word.Interfaces.CustomPropertyCollectionUpdateData |
|
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 |
|
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.DropDownListContentControlData |
|
Word.Interfaces.FieldCollectionData |
|
Word.Interfaces.FieldCollectionLoadOptions |
Wordのコレクションを格納します。フィールド オブジェクト。 |
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のコレクションを格納します。オブジェクトを一覧表示します。 |
Word.Interfaces.ListCollectionUpdateData |
|
Word.Interfaces.ListData |
|
Word.Interfaces.ListItemData |
|
Word.Interfaces.ListItemLoadOptions |
段落リスト アイテムの形式を表します。 |
Word.Interfaces.ListItemUpdateData |
|
Word.Interfaces.ListLevelCollectionData |
|
Word.Interfaces.ListLevelCollectionUpdateData |
|
Word.Interfaces.ListLevelData |
|
Word.Interfaces.ListLevelUpdateData |
|
Word.Interfaces.ListLoadOptions |
Wordのコレクションを格納します。Paragraph オブジェクト。 |
Word.Interfaces.ListTemplateData |
|
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のコレクションを格納します。範囲オブジェクト。 |
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のコレクションを格納します。セクション オブジェクト。 |
Word.Interfaces.SectionCollectionUpdateData |
|
Word.Interfaces.SectionData |
|
Word.Interfaces.SectionLoadOptions |
Word 文書内のセクションを表します。 |
Word.Interfaces.SectionUpdateData |
|
Word.Interfaces.SettingCollectionData |
|
Word.Interfaces.SettingCollectionLoadOptions |
Wordのコレクションを格納します。オブジェクトの設定。 |
Word.Interfaces.SettingCollectionUpdateData |
|
Word.Interfaces.SettingData |
|
Word.Interfaces.SettingLoadOptions |
アドインの設定を表します。 |
Word.Interfaces.SettingUpdateData |
|
Word.Interfaces.ShadingData |
|
Word.Interfaces.ShadingLoadOptions |
シェーディング オブジェクトを表します。 |
Word.Interfaces.ShadingUpdateData |
|
Word.Interfaces.StyleCollectionData |
|
Word.Interfaces.StyleCollectionLoadOptions |
Wordのコレクションを格納します。オブジェクトのスタイルを設定します。 |
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.TableStyleData |
|
Word.Interfaces.TableStyleLoadOptions |
TableStyle オブジェクトを表します。 |
Word.Interfaces.TableStyleUpdateData |
|
Word.Interfaces.TableUpdateData |
|
Word.Interfaces.TrackedChangeCollectionData |
|
Word.Interfaces.TrackedChangeCollectionLoadOptions |
Wordのコレクションを格納します。TrackedChange オブジェクト。 |
Word.Interfaces.TrackedChangeCollectionUpdateData |
|
Word.Interfaces.TrackedChangeData |
|
Word.Interfaces.TrackedChangeLoadOptions |
Word ドキュメント内の追跡された変更を表します。 |
Word.ParagraphAddedEventArgs |
paragraphAdded イベントを発生させた段落に関する情報を提供します。 |
Word.ParagraphChangedEventArgs |
paragraphChanged イベントを発生させた段落に関する情報を提供します。 |
Word.ParagraphDeletedEventArgs |
paragraphDeleted イベントを発生させた段落に関する情報を提供します。 |
列挙型
関数
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>
Office Add-ins