WordApiDesktop要件セットは、Windows と Mac の Word でのみ使用できる機能を含む特別な要件セットです。 この要件セットの API は、Windows および Mac 上の Word アプリケーションの運用 API と見なされます。 Microsoft 365 開発者サポート ポリシーに従います。
WordApiDesktop API は、他のプラットフォーム (Web など) の "プレビュー" API と見なされ、それらのプラットフォームでサポートされていない場合があります。
WordApiDesktop要件セットの API がすべてのプラットフォームでサポートされている場合は、次にリリースされた要件セット (WordApi 1.[NEXT]) に追加されます。 新しい要件セットが公開されると、これらの API もこの WordApiDesktop 要件セットで引き続きタグ付けされます。 一般的なプラットフォーム固有の要件の詳細については、「 プラットフォーム固有の要件セットについて」を参照してください。
重要
WordApiDesktop 1.5 はデスクトップのみの要件セットです。 これは、WordApiDesktop 1.4 のスーパーセットです。
推奨される使用方法
WordApiDesktop 1.5 API は Windows および Mac 上の Word でのみサポートされるため、これらの API を呼び出す前に、アドインで要件セットがサポートされているかどうかをチェックする必要があります。 これにより、サポートされていないプラットフォームでデスクトップ専用 API を使用しようとする試みを回避できます。
if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.5")) {
// Any API exclusive to this WordApiDesktop requirement set.
}
API がクロスプラットフォーム要件セットになったら、isSetSupported チェックを削除または編集する必要があります。 これにより、他のプラットフォームでのアドインの機能が有効になります。 この変更を行う際は、必ずそれらのプラットフォームで機能をテストしてください。
重要
アドインのみ (XML) マニフェストでは、アクティブ化要件としてデスクトップ専用またはオンライン専用の要件セットを指定できません。
これは、Set 要素で使用する有効な値ではありません。 統合マニフェストでは、 "requirements.capabilities" プロパティでデスクトップ専用の要件セットがサポートされています。
API リスト
次の表は、WordApiDesktop 1.5要件セットに現在含まれている Word つの JavaScript API の一覧です。 すべての Word JavaScript API (WordApiDesktop 1.5 API と以前にリリースされた API を含む) の完全なリストについては、すべての Word JavaScript API を参照してください。
| クラス | フィールド | 説明 |
|---|---|---|
| ListTemplateAddOptions | name | 指定した場合は、追加するリスト テンプレートの名前を指定します。 |
| outlineNumbered | 指定する場合は、新しいリスト テンプレートにアウトライン番号を適用するかどうかを指定します。 | |
| ListTemplateCollection | add(options?: Word.ListTemplateAddOptions) | 新しい ListTemplate オブジェクトを追加します。 |
関連項目
Office Add-ins