word package

クラス

Word.Application

アプリケーション オブジェクトを表します。

[API セット: WordApi 1.3]

Word.Body

文書またはセクションの本文を表します。

[API セット: WordApi 1.1]

Word.ContentControl

コンテンツ コントロールを表します。コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能し、ドキュメント内で境界線で区切られ、ラベルが付いた領域になる場合もあります。個々のコンテンツ コントロールには、画像、表、書式設定されたテキストの段落などの内容が含まれていることがあります。現時点では、リッチ テキスト コンテンツ コントロールのみがサポートされています。

[API セット: WordApi 1.1]

Word.ContentControlCollection

Word.ContentControl オブジェクトのコレクションを格納します。 コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能する、ラベルを付けることのできる、境界線で区切られたドキュメント内の領域です。 個々のコンテンツ コントロールには、画像、表、または書式設定されたテキストの段落などを内容として格納できます。 現在、リッチ テキストのコンテンツ コントロールのみがサポートされています。

[API セット: WordApi 1.1]

Word.CustomProperty

カスタム プロパティを表します。

[API セット: WordApi 1.3]

Word.CustomPropertyCollection

Word.CustomProperty オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.CustomXmlPart

カスタム XML パーツを表します。

[API セット: WordApi BETA (プレビューのみ)]

Word.CustomXmlPartCollection

Word.CustomXmlPart オブジェクトのコレクションを格納します。

[API セット: WordApi BETA (プレビューのみ)]

Word.CustomXmlPartScopedCollection

特定の名前空間を持 つ Word.CustomXmlPart オブジェクトのコレクションを格納します。

[API セット: WordApi BETA (プレビューのみ)]

Word.Document

Document オブジェクトは、最上位レベルのオブジェクトです。ドキュメント オブジェクトには、1 つ以上のセクション、コンテンツ コントロール、ドキュメントの内容を含む本文が含まれています。

[API セット: WordApi 1.1]

Word.DocumentCreated

DocumentCreated オブジェクトは、Application.CreateDocument によって作成されたトップ レベルのオブジェクトです。 DocumentCreated オブジェクトは特別な Document オブジェクトです。

[API セット: WordApi 1.3]

Word.DocumentProperties

ドキュメントのプロパティを表します。

[API セット: WordApi 1.3]

Word.Font

フォントを表します。

[API セット: WordApi 1.1]

Word.InlinePicture

インライン画像を表します。

[API セット: WordApi 1.1]

Word.InlinePictureCollection

Word.InlinePicture オブジェクトのコレクションを格納します。

[API セット: WordApi 1.1]

Word.List

Word.Paragraph オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.ListCollection

Word.List オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.ListItem

段落リスト アイテムの形式を表します。

[API セット: WordApi 1.3]

Word.Paragraph

選択部分、範囲、コンテンツ コントロール、または文書本文に含まれる 1 つの段落を表します。

[API セット: WordApi 1.1]

Word.ParagraphCollection

Word.Paragraph オブジェクトのコレクションを格納します。

[API セット: WordApi 1.1]

Word.Range

文書内の連続した領域を表します。

[API セット: WordApi 1.1]

Word.RangeCollection

Word.Range オブジェクトのコレクションを格納します。

[API セット: WordApi 1.1]

Word.RequestContext

RequestContext オブジェクトは、Word アプリケーションへの要求を容易にします。 Officeと Word アプリケーションは 2 つの異なるプロセスで実行されますので、アドインから Word オブジェクト モデルにアクセスするには、要求コンテキストが必要です。

Word.SearchOptions

検索操作に含めるオプションを指定します。

Word JavaScript API で検索オプションを使用する方法の詳細については、「検索オプションを使用して Word アドイン内のテキストを検索する」 を参照してください。.

[API セット: WordApi 1.1]

Word.Section

Word 文書内のセクションを表します。

[API セット: WordApi 1.1]

Word.SectionCollection

ドキュメントの Word.Section オブジェクトの コレクションを格納 します。

[API セット: WordApi 1.1]

Word.Setting

アドインの設定を表します。

[API セット: WordApi BETA (プレビューのみ)]

Word.SettingCollection

Word.Setting オブジェクトのコレクションを格納します。

[API セット: WordApi BETA (プレビューのみ)]

Word.Table

Word ドキュメント内のテーブルを表します。

[API セット: WordApi 1.3]

Word.TableBorder

境界のスタイルを指定します。

[API セット: WordApi 1.3]

Word.TableCell

Word ドキュメント内のテーブル セルを表します。

[API セット: WordApi 1.3]

Word.TableCellCollection

ドキュメントの TableCell オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.TableCollection

ドキュメントの Table オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.TableRow

Word 文書内の行を表します。

[API セット: WordApi 1.3]

Word.TableRowCollection

ドキュメントの TableRow オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

インターフェイス

Word.ContentControlEventArgs

イベントを発生したコンテンツ コントロールに関する情報を提供します。

[API セット: WordApi BETA (プレビューのみ)]

Word.Interfaces.BodyData

呼び出しによって返されるデータを説明するインターフェイス body.toJSON().

Word.Interfaces.BodyLoadOptions

文書またはセクションの本文を表します。

[API セット: WordApi 1.1]

Word.Interfaces.BodyUpdateData

Body オブジェクト上のデータを更新するためのインターフェイスです。 body.set({ ... }).

Word.Interfaces.CollectionLoadOptions

コレクションのメンバーのサブセットのプロパティのみを読み込む方法を提供します。

Word.Interfaces.ContentControlCollectionData

呼び出しによって返されるデータを説明するインターフェイス contentControlCollection.toJSON().

Word.Interfaces.ContentControlCollectionLoadOptions

Word.ContentControl オブジェクトのコレクションを格納します。 コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能する、ラベルを付けることのできる、境界線で区切られたドキュメント内の領域です。 個々のコンテンツ コントロールには、画像、表、または書式設定されたテキストの段落などを内容として格納できます。 現在、リッチ テキストのコンテンツ コントロールのみがサポートされています。

[API セット: WordApi 1.1]

Word.Interfaces.ContentControlCollectionUpdateData

で使用する ContentControlCollection オブジェクトのデータを更新するためのインターフェイス contentControlCollection.set({ ... }).

Word.Interfaces.ContentControlData

呼び出しによって返されるデータを説明するインターフェイス contentControl.toJSON().

Word.Interfaces.ContentControlLoadOptions

コンテンツ コントロールを表します。コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能し、ドキュメント内で境界線で区切られ、ラベルが付いた領域になる場合もあります。個々のコンテンツ コントロールには、画像、表、書式設定されたテキストの段落などの内容が含まれていることがあります。現時点では、リッチ テキスト コンテンツ コントロールのみがサポートされています。

[API セット: WordApi 1.1]

Word.Interfaces.ContentControlUpdateData

ContentControl オブジェクト上のデータを更新するためのインターフェイスです。 contentControl.set({ ... }).

Word.Interfaces.CustomPropertyCollectionData

呼び出しによって返されるデータを説明するインターフェイス customPropertyCollection.toJSON().

Word.Interfaces.CustomPropertyCollectionLoadOptions

Word.CustomProperty オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.Interfaces.CustomPropertyCollectionUpdateData

CustomPropertyCollection オブジェクトのデータを更新するためのインターフェイスです。 customPropertyCollection.set({ ... }).

Word.Interfaces.CustomPropertyData

呼び出しによって返されるデータを説明するインターフェイス customProperty.toJSON().

Word.Interfaces.CustomPropertyLoadOptions

カスタム プロパティを表します。

[API セット: WordApi 1.3]

Word.Interfaces.CustomPropertyUpdateData

CustomProperty オブジェクトのデータを更新するためのインターフェイスです。 customProperty.set({ ... }).

Word.Interfaces.CustomXmlPartCollectionData

呼び出しによって返されるデータを説明するインターフェイス customXmlPartCollection.toJSON().

Word.Interfaces.CustomXmlPartCollectionLoadOptions

Word.CustomXmlPart オブジェクトのコレクションを格納します。

[API セット: WordApi BETA (プレビューのみ)]

Word.Interfaces.CustomXmlPartCollectionUpdateData

CustomXmlPartCollection オブジェクトのデータを更新するためのインターフェイスです。 customXmlPartCollection.set({ ... }).

Word.Interfaces.CustomXmlPartData

呼び出しによって返されるデータを説明するインターフェイス customXmlPart.toJSON().

Word.Interfaces.CustomXmlPartLoadOptions

カスタム XML パーツを表します。

[API セット: WordApi BETA (プレビューのみ)]

Word.Interfaces.CustomXmlPartScopedCollectionData

呼び出しによって返されるデータを説明するインターフェイス customXmlPartScopedCollection.toJSON().

Word.Interfaces.CustomXmlPartScopedCollectionLoadOptions

特定の名前空間を持 つ Word.CustomXmlPart オブジェクトのコレクションを格納します。

[API セット: WordApi BETA (プレビューのみ)]

Word.Interfaces.CustomXmlPartScopedCollectionUpdateData

CustomXmlPartScopedCollection オブジェクトのデータを更新するためのインターフェイスです。 customXmlPartScopedCollection.set({ ... }).

Word.Interfaces.DocumentCreatedData

呼び出しによって返されるデータを説明するインターフェイス documentCreated.toJSON().

Word.Interfaces.DocumentCreatedLoadOptions

DocumentCreated オブジェクトは、Application.CreateDocument によって作成されたトップ レベルのオブジェクトです。 DocumentCreated オブジェクトは特別な Document オブジェクトです。

[API セット: WordApi 1.3]

Word.Interfaces.DocumentCreatedUpdateData

DocumentCreated オブジェクト上のデータを更新するためのインターフェイスです。 documentCreated.set({ ... }).

Word.Interfaces.DocumentData

呼び出しによって返されるデータを説明するインターフェイス document.toJSON().

Word.Interfaces.DocumentLoadOptions

Document オブジェクトは、最上位レベルのオブジェクトです。ドキュメント オブジェクトには、1 つ以上のセクション、コンテンツ コントロール、ドキュメントの内容を含む本文が含まれています。

[API セット: WordApi 1.1]

Word.Interfaces.DocumentPropertiesData

呼び出しによって返されるデータを説明するインターフェイス documentProperties.toJSON().

Word.Interfaces.DocumentPropertiesLoadOptions

ドキュメントのプロパティを表します。

[API セット: WordApi 1.3]

Word.Interfaces.DocumentPropertiesUpdateData

DocumentProperties オブジェクトのデータを更新するためのインターフェイスです。 documentProperties.set({ ... }).

Word.Interfaces.DocumentUpdateData

Document オブジェクトのデータを更新するためのインターフェイスです。 document.set({ ... }).

Word.Interfaces.FontData

呼び出しによって返されるデータを説明するインターフェイス font.toJSON().

Word.Interfaces.FontLoadOptions

フォントを表します。

[API セット: WordApi 1.1]

Word.Interfaces.FontUpdateData

Font オブジェクトのデータを更新するためのインターフェイスです。 font.set({ ... }).

Word.Interfaces.InlinePictureCollectionData

呼び出しによって返されるデータを説明するインターフェイス inlinePictureCollection.toJSON().

Word.Interfaces.InlinePictureCollectionLoadOptions

Word.InlinePicture オブジェクトのコレクションを格納します。

[API セット: WordApi 1.1]

Word.Interfaces.InlinePictureCollectionUpdateData

InlinePictureCollection オブジェクトのデータを更新するためのインターフェイスです。 inlinePictureCollection.set({ ... }).

Word.Interfaces.InlinePictureData

呼び出しによって返されるデータを説明するインターフェイス inlinePicture.toJSON().

Word.Interfaces.InlinePictureLoadOptions

インライン画像を表します。

[API セット: WordApi 1.1]

Word.Interfaces.InlinePictureUpdateData

InlinePicture オブジェクトのデータを更新するためのインターフェイスです。 inlinePicture.set({ ... }).

Word.Interfaces.ListCollectionData

呼び出しによって返されるデータを説明するインターフェイス listCollection.toJSON().

Word.Interfaces.ListCollectionLoadOptions

Word.List オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.Interfaces.ListCollectionUpdateData

ListCollection オブジェクトのデータを更新するためのインターフェイスです。 listCollection.set({ ... }).

Word.Interfaces.ListData

呼び出しによって返されるデータを説明するインターフェイス list.toJSON().

Word.Interfaces.ListItemData

呼び出しによって返されるデータを説明するインターフェイス listItem.toJSON().

Word.Interfaces.ListItemLoadOptions

段落リスト アイテムの形式を表します。

[API セット: WordApi 1.3]

Word.Interfaces.ListItemUpdateData

ListItem オブジェクトのデータを更新するためのインターフェイスです。 listItem.set({ ... }).

Word.Interfaces.ListLoadOptions

Word.Paragraph オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.Interfaces.ParagraphCollectionData

呼び出しによって返されるデータを説明するインターフェイス paragraphCollection.toJSON().

Word.Interfaces.ParagraphCollectionLoadOptions

Word.Paragraph オブジェクトのコレクションを格納します。

[API セット: WordApi 1.1]

Word.Interfaces.ParagraphCollectionUpdateData

ParagraphCollection オブジェクトのデータを更新するためのインターフェイスです。 paragraphCollection.set({ ... }).

Word.Interfaces.ParagraphData

呼び出しによって返されるデータを説明するインターフェイス paragraph.toJSON().

Word.Interfaces.ParagraphLoadOptions

選択部分、範囲、コンテンツ コントロール、または文書本文に含まれる 1 つの段落を表します。

[API セット: WordApi 1.1]

Word.Interfaces.ParagraphUpdateData

Paragraph オブジェクトのデータを更新するためのインターフェイスです。 paragraph.set({ ... }).

Word.Interfaces.RangeCollectionData

呼び出しによって返されるデータを説明するインターフェイス rangeCollection.toJSON().

Word.Interfaces.RangeCollectionLoadOptions

Word.Range オブジェクトのコレクションを格納します。

[API セット: WordApi 1.1]

Word.Interfaces.RangeCollectionUpdateData

RangeCollection オブジェクト上のデータを更新するためのインターフェイスです。 rangeCollection.set({ ... }).

Word.Interfaces.RangeData

呼び出しによって返されるデータを説明するインターフェイス range.toJSON().

Word.Interfaces.RangeLoadOptions

文書内の連続した領域を表します。

[API セット: WordApi 1.1]

Word.Interfaces.RangeUpdateData

Range オブジェクトで使用するデータを更新するためのインターフェイス range.set({ ... }).

Word.Interfaces.SearchOptionsData

呼び出しによって返されるデータを説明するインターフェイス searchOptions.toJSON().

Word.Interfaces.SearchOptionsLoadOptions

検索操作に含めるオプションを指定します。

[API セット: WordApi 1.1]

Word.Interfaces.SearchOptionsUpdateData

SearchOptions オブジェクト上のデータを更新するためのインターフェイスです。 searchOptions.set({ ... }).

Word.Interfaces.SectionCollectionData

呼び出しによって返されるデータを説明するインターフェイス sectionCollection.toJSON().

Word.Interfaces.SectionCollectionLoadOptions

ドキュメントの Word.Section オブジェクトの コレクションを格納 します。

[API セット: WordApi 1.1]

Word.Interfaces.SectionCollectionUpdateData

SectionCollection オブジェクトのデータを更新するためのインターフェイスです。 sectionCollection.set({ ... }).

Word.Interfaces.SectionData

呼び出しによって返されるデータを説明するインターフェイス section.toJSON().

Word.Interfaces.SectionLoadOptions

Word 文書内のセクションを表します。

[API セット: WordApi 1.1]

Word.Interfaces.SectionUpdateData

Section オブジェクト上のデータを更新するためのインターフェイスです。 section.set({ ... }).

Word.Interfaces.SettingCollectionData

呼び出しによって返されるデータを説明するインターフェイス settingCollection.toJSON().

Word.Interfaces.SettingCollectionLoadOptions

Word.Setting オブジェクトのコレクションを格納します。

[API セット: WordApi BETA (プレビューのみ)]

Word.Interfaces.SettingCollectionUpdateData

で使用する SettingCollection オブジェクトのデータを更新するためのインターフェイス settingCollection.set({ ... }).

Word.Interfaces.SettingData

呼び出しによって返されるデータを説明するインターフェイス setting.toJSON().

Word.Interfaces.SettingLoadOptions

アドインの設定を表します。

[API セット: WordApi BETA (プレビューのみ)]

Word.Interfaces.SettingUpdateData

で使用するために、Setting オブジェクトのデータを更新するためのインターフェイス setting.set({ ... }).

Word.Interfaces.TableBorderData

呼び出しによって返されるデータを説明するインターフェイス tableBorder.toJSON().

Word.Interfaces.TableBorderLoadOptions

境界のスタイルを指定します。

[API セット: WordApi 1.3]

Word.Interfaces.TableBorderUpdateData

で使用する TableBorder オブジェクトのデータを更新するためのインターフェイス tableBorder.set({ ... }).

Word.Interfaces.TableCellCollectionData

呼び出しによって返されるデータを説明するインターフェイス tableCellCollection.toJSON().

Word.Interfaces.TableCellCollectionLoadOptions

ドキュメントの TableCell オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.Interfaces.TableCellCollectionUpdateData

TableCellCollection オブジェクトのデータを更新するためのインターフェイスです。 tableCellCollection.set({ ... }).

Word.Interfaces.TableCellData

呼び出しによって返されるデータを説明するインターフェイス tableCell.toJSON().

Word.Interfaces.TableCellLoadOptions

Word ドキュメント内のテーブル セルを表します。

[API セット: WordApi 1.3]

Word.Interfaces.TableCellUpdateData

TableCell オブジェクト上のデータを更新するためのインターフェイスです。 tableCell.set({ ... }).

Word.Interfaces.TableCollectionData

呼び出しによって返されるデータを説明するインターフェイス tableCollection.toJSON().

Word.Interfaces.TableCollectionLoadOptions

ドキュメントの Table オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.Interfaces.TableCollectionUpdateData

TableCollection オブジェクト上のデータを更新するためのインターフェイスです。 tableCollection.set({ ... }).

Word.Interfaces.TableData

呼び出しによって返されるデータを説明するインターフェイス table.toJSON().

Word.Interfaces.TableLoadOptions

Word ドキュメント内のテーブルを表します。

[API セット: WordApi 1.3]

Word.Interfaces.TableRowCollectionData

呼び出しによって返されるデータを説明するインターフェイス tableRowCollection.toJSON().

Word.Interfaces.TableRowCollectionLoadOptions

ドキュメントの TableRow オブジェクトのコレクションを格納します。

[API セット: WordApi 1.3]

Word.Interfaces.TableRowCollectionUpdateData

で使用する TableRowCollection オブジェクトのデータを更新するためのインターフェイス tableRowCollection.set({ ... }).

Word.Interfaces.TableRowData

呼び出しによって返されるデータを説明するインターフェイス tableRow.toJSON().

Word.Interfaces.TableRowLoadOptions

Word 文書内の行を表します。

[API セット: WordApi 1.3]

Word.Interfaces.TableRowUpdateData

TableRow オブジェクト上のデータを更新するためのインターフェイスです。 tableRow.set({ ... }).

Word.Interfaces.TableUpdateData

で使用する Table オブジェクトのデータを更新するためのインターフェイス table.set({ ... }).

列挙型

Word.Alignment

[API セット: WordApi]

Word.BodyType

[API セット: WordApi]

Word.BorderLocation

[API セット: WordApi]

Word.BorderType

[API セット: WordApi]

Word.BreakType

区切りの形式を指定します。

[API セット: WordApi]

Word.CellPaddingLocation

[API セット: WordApi]

Word.ContentControlAppearance

ContentControl の外観。

[API セット: WordApi]

Word.ContentControlType

サポートされているコンテンツ コントロールの種類とサブタイプを指定します。

[API セット: WordApi]

Word.DocumentPropertyType

[API セット: WordApi]

Word.ErrorCodes
Word.EventType

発生したイベントの種類に関する情報を提供します。 オブジェクトの種類ごとに、削除、選択の変更、データの変更、追加の順序を維持してください。

[API セット: WordApi]

Word.FileContentFormat

[API セット: WordApi]

Word.HeaderFooterType

[API セット: WordApi]

Word.ImageFormat

[API セット: WordApi]

Word.InsertLocation

挿入場所の種類。

[API セット: WordApi]

Word.ListBullet

[API セット: WordApi]

Word.ListLevelType

[API セット: WordApi]

Word.ListNumbering

[API セット: WordApi]

Word.LocationRelation

[API セット: WordApi]

Word.RangeLocation

[API セット: WordApi]

Word.SelectionMode

この列挙型は、文書内のカーソル (カーソル位置) が選択範囲の後の位置を設定します。

[API セット: WordApi 1.1]

Word.Style

[API セット: WordApi]

Word.TapObjectType

[API セット: WordApi]

Word.UnderlineType

下線形式でサポートされているスタイル。

[API セット: WordApi]

Word.VerticalAlignment

[API セット: WordApi]

機能

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 を取り込み、約束を返す関数 (通常、"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 を取り込み、約束を返す関数 (通常、"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 を取り込み、約束を返す関数 (通常、"context.sync()" の結果だけです)。 context パラメーターは、Word アプリケーションへの要求を容易にします。 このアドインOffice Word アプリケーションは 2 つの異なるプロセスで実行されますので、アドインから Word オブジェクト モデルにアクセスするには RequestContext が必要です。

戻り値

Promise<T>

注釈

この署名に加えて、メソッドには次の署名も含まれています。これにより、以前に作成したオブジェクトの要求コンテキストを使用して再開できます。

run (object: OfficeExtension.ClientObject, batch: (context: Word.RequestContext) => Promise : Promise ;

run (オブジェクト: OfficeExtension.ClientObject [ ] , batch: (context: Word.RequestContext) => Promise : Promise ;