word package

リファレンス

クラス

Word.Application	アプリケーションオブジェクトを表します。
Word.Body	文書またはセクションの本文を表します。
Word.ContentControl	コンテンツコントロールを表します。コンテンツコントロールは、特定の種類のコンテンツのコンテナーとして機能し、ドキュメント内で境界線で区切られ、ラベルが付いた領域になる場合もあります。個々のコンテンツコントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。現時点では、リッチテキスト、プレーンテキスト、およびチェックボックスコンテンツコントロールのみがサポートされています。
Word.ContentControlCollection	Word.ContentControl オブジェクトのコレクションを格納します。コンテンツコントロールは、特定の種類のコンテンツのコンテナーとして機能する、ラベルを付けることのできる、境界線で区切られたドキュメント内の領域です。個々のコンテンツコントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。現時点では、リッチテキストとプレーンテキストコンテンツコントロールのみがサポートされています。
Word.CustomProperty	カスタムプロパティを表します。
Word.CustomPropertyCollection	Word.CustomProperty オブジェクトのコレクションを格納します。
Word.Document	Document オブジェクトは、最上位レベルのオブジェクトです。ドキュメントオブジェクトには、1 つ以上のセクション、コンテンツコントロール、ドキュメントの内容を含む本文が含まれています。
Word.DocumentCreated	DocumentCreated オブジェクトは、Application.CreateDocument によって作成された最上位のオブジェクトです。 DocumentCreated オブジェクトは、特殊な Document オブジェクトです。
Word.DocumentProperties	ドキュメントプロパティを表します。
Word.Font	フォントを表します。
Word.InlinePicture	インライン画像を表します。
Word.InlinePictureCollection	Word.InlinePicture オブジェクトのコレクションを格納します。
Word.List	Word.Paragraph オブジェクトのコレクションを格納します。
Word.ListCollection	Word.List オブジェクトのコレクションを格納します。
Word.ListItem	段落リストアイテムの形式を表します。
Word.Paragraph	選択部分、範囲、コンテンツコントロール、または文書本文に含まれる 1 つの段落を表します。
Word.ParagraphCollection	Word.Paragraph オブジェクトのコレクションを格納します。
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.Style	Word 文書のスタイルを表します。
Word.Table	Word 文書内のテーブルを表します。
Word.TableBorder	境界のスタイルを指定します。
Word.TableCell	Word 文書の表のセルを表します。
Word.TableCellCollection	ドキュメントの TableCell オブジェクトのコレクションを格納します。
Word.TableCollection	ドキュメントの Table オブジェクトのコレクションを格納します。
Word.TableRow	Word 文書の行を表します。
Word.TableRowCollection	ドキュメントの TableRow オブジェクトのコレクションを格納します。

インターフェイス

Word.Interfaces.AnnotationCollectionData	`annotationCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.AnnotationCollectionUpdateData	`annotationCollection.set({ ... })`で使用するために、`AnnotationCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.AnnotationData	`annotation.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.BodyData	`body.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.BodyLoadOptions	文書またはセクションの本文を表します。
Word.Interfaces.BodyUpdateData	`body.set({ ... })`で使用するために、`Body` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.CheckboxContentControlData	`checkboxContentControl.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CheckboxContentControlUpdateData	`checkboxContentControl.set({ ... })`で使用するために、`CheckboxContentControl` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.CollectionLoadOptions	コレクションのメンバーのサブセットのみのプロパティを読み込む方法を提供します。
Word.Interfaces.CommentCollectionData	`commentCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CommentCollectionUpdateData	`commentCollection.set({ ... })`で使用するために、`CommentCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.CommentContentRangeData	`commentContentRange.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CommentContentRangeUpdateData	`commentContentRange.set({ ... })`で使用するために、`CommentContentRange` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.CommentData	`comment.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CommentReplyCollectionData	`commentReplyCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CommentReplyCollectionUpdateData	`commentReplyCollection.set({ ... })`で使用するために、`CommentReplyCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.CommentReplyData	`commentReply.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CommentReplyUpdateData	`commentReply.set({ ... })`で使用するために、`CommentReply` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.CommentUpdateData	`comment.set({ ... })`で使用するために、`Comment` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.ContentControlCollectionData	`contentControlCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.ContentControlCollectionLoadOptions	Word.ContentControl オブジェクトのコレクションを格納します。コンテンツコントロールは、特定の種類のコンテンツのコンテナーとして機能する、ラベルを付けることのできる、境界線で区切られたドキュメント内の領域です。個々のコンテンツコントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。現時点では、リッチテキストとプレーンテキストコンテンツコントロールのみがサポートされています。
Word.Interfaces.ContentControlCollectionUpdateData	`contentControlCollection.set({ ... })`で使用するために、`ContentControlCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.ContentControlData	`contentControl.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.ContentControlLoadOptions	コンテンツコントロールを表します。コンテンツコントロールは、特定の種類のコンテンツのコンテナーとして機能し、ドキュメント内で境界線で区切られ、ラベルが付いた領域になる場合もあります。個々のコンテンツコントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。現時点では、リッチテキスト、プレーンテキスト、およびチェックボックスコンテンツコントロールのみがサポートされています。
Word.Interfaces.ContentControlUpdateData	`contentControl.set({ ... })`で使用するために、`ContentControl` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.CritiqueAnnotationData	`critiqueAnnotation.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CustomPropertyCollectionData	`customPropertyCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CustomPropertyCollectionLoadOptions	Word.CustomProperty オブジェクトのコレクションを格納します。
Word.Interfaces.CustomPropertyCollectionUpdateData	`customPropertyCollection.set({ ... })`で使用するために、`CustomPropertyCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.CustomPropertyData	`customProperty.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CustomPropertyLoadOptions	カスタムプロパティを表します。
Word.Interfaces.CustomPropertyUpdateData	`customProperty.set({ ... })`で使用するために、`CustomProperty` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.CustomXmlPartCollectionData	`customXmlPartCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CustomXmlPartCollectionUpdateData	`customXmlPartCollection.set({ ... })`で使用するために、`CustomXmlPartCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.CustomXmlPartData	`customXmlPart.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CustomXmlPartScopedCollectionData	`customXmlPartScopedCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.CustomXmlPartScopedCollectionUpdateData	`customXmlPartScopedCollection.set({ ... })`で使用するために、`CustomXmlPartScopedCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.DocumentCreatedData	`documentCreated.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.DocumentCreatedLoadOptions	DocumentCreated オブジェクトは、Application.CreateDocument によって作成された最上位のオブジェクトです。 DocumentCreated オブジェクトは、特殊な Document オブジェクトです。
Word.Interfaces.DocumentCreatedUpdateData	`documentCreated.set({ ... })`で使用するために、`DocumentCreated` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.DocumentData	`document.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.DocumentLoadOptions	Document オブジェクトは、最上位レベルのオブジェクトです。ドキュメントオブジェクトには、1 つ以上のセクション、コンテンツコントロール、ドキュメントの内容を含む本文が含まれています。
Word.Interfaces.DocumentPropertiesData	`documentProperties.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.DocumentPropertiesLoadOptions	ドキュメントプロパティを表します。
Word.Interfaces.DocumentPropertiesUpdateData	`documentProperties.set({ ... })`で使用するために、`DocumentProperties` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.DocumentUpdateData	`document.set({ ... })`で使用するために、`Document` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.FieldCollectionData	`fieldCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.FieldCollectionUpdateData	`fieldCollection.set({ ... })`で使用するために、`FieldCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.FieldData	`field.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.FieldUpdateData	`field.set({ ... })`で使用するために、`Field` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.FontData	`font.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.FontLoadOptions	フォントを表します。
Word.Interfaces.FontUpdateData	`font.set({ ... })`で使用するために、`Font` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.InlinePictureCollectionData	`inlinePictureCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.InlinePictureCollectionLoadOptions	Word.InlinePicture オブジェクトのコレクションを格納します。
Word.Interfaces.InlinePictureCollectionUpdateData	`inlinePictureCollection.set({ ... })`で使用するために、`InlinePictureCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.InlinePictureData	`inlinePicture.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.InlinePictureLoadOptions	インライン画像を表します。
Word.Interfaces.InlinePictureUpdateData	`inlinePicture.set({ ... })`で使用するために、`InlinePicture` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.ListCollectionData	`listCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.ListCollectionLoadOptions	Word.List オブジェクトのコレクションを格納します。
Word.Interfaces.ListCollectionUpdateData	`listCollection.set({ ... })`で使用するために、`ListCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.ListData	`list.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.ListItemData	`listItem.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.ListItemLoadOptions	段落リストアイテムの形式を表します。
Word.Interfaces.ListItemUpdateData	`listItem.set({ ... })`で使用するために、`ListItem` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.ListLoadOptions	Word.Paragraph オブジェクトのコレクションを格納します。
Word.Interfaces.NoteItemCollectionData	`noteItemCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.NoteItemCollectionUpdateData	`noteItemCollection.set({ ... })`で使用するために、`NoteItemCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.NoteItemData	`noteItem.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.NoteItemUpdateData	`noteItem.set({ ... })`で使用するために、`NoteItem` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.ParagraphCollectionData	`paragraphCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.ParagraphCollectionLoadOptions	Word.Paragraph オブジェクトのコレクションを格納します。
Word.Interfaces.ParagraphCollectionUpdateData	`paragraphCollection.set({ ... })`で使用するために、`ParagraphCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.ParagraphData	`paragraph.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.ParagraphFormatData	`paragraphFormat.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.ParagraphFormatUpdateData	`paragraphFormat.set({ ... })`で使用するために、`ParagraphFormat` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.ParagraphLoadOptions	選択部分、範囲、コンテンツコントロール、または文書本文に含まれる 1 つの段落を表します。
Word.Interfaces.ParagraphUpdateData	`paragraph.set({ ... })`で使用するために、`Paragraph` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.RangeCollectionData	`rangeCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.RangeCollectionLoadOptions	Word.Range オブジェクトのコレクションを格納します。
Word.Interfaces.RangeCollectionUpdateData	`rangeCollection.set({ ... })`で使用するために、`RangeCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.RangeData	`range.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.RangeLoadOptions	文書内の連続した領域を表します。
Word.Interfaces.RangeUpdateData	`range.set({ ... })`で使用するために、`Range` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.SearchOptionsData	`searchOptions.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.SearchOptionsLoadOptions	検索操作に含めるオプションを指定します。 Word JavaScript API で検索オプションを使用する方法の詳細については、「検索オプションを使用して Word アドイン内のテキストを検索する」を参照してください。
Word.Interfaces.SearchOptionsUpdateData	`searchOptions.set({ ... })`で使用するために、`SearchOptions` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.SectionCollectionData	`sectionCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.SectionCollectionLoadOptions	文書の Word.Section オブジェクトのコレクションを格納します。
Word.Interfaces.SectionCollectionUpdateData	`sectionCollection.set({ ... })`で使用するために、`SectionCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.SectionData	`section.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.SectionLoadOptions	Word 文書内のセクションを表します。
Word.Interfaces.SectionUpdateData	`section.set({ ... })`で使用するために、`Section` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.SettingCollectionData	`settingCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.SettingCollectionUpdateData	`settingCollection.set({ ... })`で使用するために、`SettingCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.SettingData	`setting.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.SettingUpdateData	`setting.set({ ... })`で使用するために、`Setting` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.ShadingData	`shading.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.ShadingUpdateData	`shading.set({ ... })`で使用するために、`Shading` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.StyleCollectionData	`styleCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.StyleCollectionUpdateData	`styleCollection.set({ ... })`で使用するために、`StyleCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.StyleData	`style.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.StyleLoadOptions	Word 文書のスタイルを表します。
Word.Interfaces.StyleUpdateData	`style.set({ ... })`で使用するために、`Style` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.TableBorderData	`tableBorder.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.TableBorderLoadOptions	境界のスタイルを指定します。
Word.Interfaces.TableBorderUpdateData	`tableBorder.set({ ... })`で使用するために、`TableBorder` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.TableCellCollectionData	`tableCellCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.TableCellCollectionLoadOptions	ドキュメントの TableCell オブジェクトのコレクションを格納します。
Word.Interfaces.TableCellCollectionUpdateData	`tableCellCollection.set({ ... })`で使用するために、`TableCellCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.TableCellData	`tableCell.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.TableCellLoadOptions	Word 文書の表のセルを表します。
Word.Interfaces.TableCellUpdateData	`tableCell.set({ ... })`で使用するために、`TableCell` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.TableCollectionData	`tableCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.TableCollectionLoadOptions	ドキュメントの Table オブジェクトのコレクションを格納します。
Word.Interfaces.TableCollectionUpdateData	`tableCollection.set({ ... })`で使用するために、`TableCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.TableData	`table.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.TableLoadOptions	Word 文書内のテーブルを表します。
Word.Interfaces.TableRowCollectionData	`tableRowCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.TableRowCollectionLoadOptions	ドキュメントの TableRow オブジェクトのコレクションを格納します。
Word.Interfaces.TableRowCollectionUpdateData	`tableRowCollection.set({ ... })`で使用するために、`TableRowCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.TableRowData	`tableRow.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.TableRowLoadOptions	Word 文書の行を表します。
Word.Interfaces.TableRowUpdateData	`tableRow.set({ ... })`で使用するために、`TableRow` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.TableStyleData	`tableStyle.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.TableStyleUpdateData	`tableStyle.set({ ... })`で使用するために、`TableStyle` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.TableUpdateData	`table.set({ ... })`で使用するために、`Table` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.TrackedChangeCollectionData	`trackedChangeCollection.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。
Word.Interfaces.TrackedChangeCollectionUpdateData	`trackedChangeCollection.set({ ... })`で使用するために、`TrackedChangeCollection` オブジェクト上のデータを更新するためのインターフェイス。
Word.Interfaces.TrackedChangeData	`trackedChange.toJSON()`を呼び出すことによって返されるデータを記述するインターフェイス。

列挙型

Word.Alignment
Word.BodyType
Word.BorderLocation
Word.BorderType
Word.BreakType	区切りの形式を指定します。
Word.BuiltInStyleName	Word 文書の組み込みスタイルを表します。
Word.CellPaddingLocation
Word.ContentControlAppearance	ContentControl の外観。
Word.ContentControlType	サポートされているコンテンツコントロールの種類とサブタイプを指定します。
Word.DocumentPropertyType
Word.ErrorCodes
Word.HeaderFooterType
Word.InsertLocation	挿入場所の種類。
Word.ListBullet
Word.ListLevelType
Word.ListNumbering
Word.LocationRelation
Word.RangeLocation
Word.SaveBehavior	`Document.save`の保存動作を指定します。
Word.SelectionMode	この列挙型は、文書内のカーソル (カーソル) が選択範囲の後にある場所を設定します。
Word.UnderlineType	下線形式でサポートされているスタイル。
Word.VerticalAlignment

関数

Word.run(objects, batch)	以前に作成した API オブジェクトの RequestContext を使用して、Word オブジェクトモデルに対してアクションを実行するバッチスクリプトを実行します。
Word.run(object, batch)	以前に作成した API オブジェクトの RequestContext を使用して、Word オブジェクトモデルに対してアクションを実行するバッチスクリプトを実行します。 promise が解決されると、実行中に自動的に割り当てられた追跡対象オブジェクトが解放されます。
Word.run(batch)	新しい 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: 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(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>

戻り値

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>

戻り値

Promise<T>

次の方法で共有

word package

クラス

インターフェイス

列挙型

関数

関数の詳細

Word.run(objects, batch)

パラメーター

戻り値

Word.run(object, batch)

パラメーター

戻り値

Word.run(batch)

パラメーター

戻り値

フィードバック

その他のリソース