WordApiHiddenDocument 1.5要件セットは、Windows と Mac の Word でのみ使用できる機能を含む特別な要件セットです。 この要件セットの API は、Windows および Mac 上の Word アプリケーションの運用 API と見なされます。 Microsoft 365 開発者サポート ポリシーに従います。
WordApiHiddenDocument API は、他のプラットフォーム (Web、iPad) の "プレビュー" API と見なされ、これらのプラットフォームでサポートされていない場合があります。
重要
WordApiHiddenDocument 1.5 は、WordApi 1.5 および WordApiHiddenDocument 1.4 要件セットのスーパーセットであり、デスクトップのみの要件セットです。
推奨される使用方法
WordApiHiddenDocument API は Windows および Mac 上の Word でのみサポートされるため、これらの API を呼び出す前に、アドインチェック要件セットがサポートされているかどうかを確認する必要があります。 これにより、サポートされていないプラットフォームでデスクトップ専用 API を使用しようとする試みを回避できます。
if (Office.context.requirements.isSetSupported("WordApiHiddenDocument", "1.5")) {
// Any API exclusive to this desktop-only requirement set.
}
API がクロスプラットフォーム要件セットになったら、isSetSupported チェックを削除または編集する必要があります。 これにより、他のプラットフォームでのアドインの機能が有効になります。 この変更を行う際は、必ずそれらのプラットフォームで機能をテストしてください。
重要
マニフェストでアクティブ化要件として WordApiHiddenDocument 1.5 を指定できません。
Set 要素で使用する有効な値ではありません。
API リスト
次の表は、WordApiHiddenDocument 1.5要件セットに現在含まれている Word つの JavaScript API の一覧です。 すべての Word JavaScript API (WordApiHiddenDocument 1.5 API と以前にリリースされた API を含む) の完全なリストについては、すべての Word JavaScript API を参照してください。
| クラス | フィールド | 説明 |
|---|---|---|
| DocumentCreated | addStyle(name: string, type: Word.StyleType) | 名前と種類で文書にスタイルを追加します。 |
| getContentControls(options?: Word.ContentControlOptions) | ドキュメント内の現在サポートされているコンテンツ コントロールを取得します。 | |
| getStyles() | ドキュメントのスタイル セット全体を表す StyleCollection オブジェクトを取得します。 | |
| insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace |Word.InsertLocation.start |Word.InsertLocation.end |"Replace" |"開始" |"End", insertFileOptions?: Word.InsertFileOptions) | 追加プロパティを使用してターゲット ドキュメントの特定の位置にドキュメントを挿入します。 | |
| save(saveBehavior?: Word.SaveBehavior, fileName?: string) | ドキュメントを保存します。 |
関連項目
Office Add-ins