WordApiDesktop要件セットは、Windows、Mac、iPad のWordでのみ使用できる機能を含む特別な要件セットです。 この要件セットの API は、Windows、Mac、iPad 上の Word アプリケーション用の運用 API と見なされます。 Microsoft 365 開発者サポート ポリシーに従います。
WordApiDesktop API は、他のプラットフォーム (Web) の "プレビュー" API と見なされ、これらのプラットフォームでサポートされていない場合があります。
WordApiDesktop要件セットの API がすべてのプラットフォームでサポートされている場合は、次にリリースされた要件セット (WordApi 1.[NEXT]) に追加されます。 新しい要件セットが公開されると、これらの API もこの WordApiDesktop 要件セットで引き続きタグ付けされます。 一般的なプラットフォーム固有の要件の詳細については、「 プラットフォーム固有の要件セットについて」を参照してください。
重要
WordApiDesktop 1.1 はデスクトップのみの要件セットです。 これは WordApi 1.8 のスーパーセットです。
推奨される使用方法
WordApiDesktop 1.1 API は Windows、Mac、iPad の Word でのみサポートされるため、アドインチェック要件セットがサポートされている場合は、これらの API を呼び出す必要があります。 これにより、サポートされていないプラットフォームでデスクトップ専用 API を使用しようとする試みを回避できます。
if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.1")) {
// Any API exclusive to this WordApiDesktop requirement set.
}
API がクロスプラットフォーム要件セットになったら、isSetSupported チェックを削除または編集する必要があります。 これにより、他のプラットフォームでのアドインの機能が有効になります。 この変更を行う際は、必ずそれらのプラットフォームで機能をテストしてください。
重要
マニフェストでアクティブ化要件として WordApiDesktop 1.1 を指定できません。
これは、Set 要素で使用する有効な値ではありません。
API リスト
次の表は、WordApiDesktop 1.1要件セットに現在含まれている Word つの JavaScript API の一覧です。 すべての Word JavaScript API (WordApiDesktop 1.1 API と以前にリリースされた API を含む) の完全なリストについては、すべての Word JavaScript API を参照してください。
| クラス | フィールド | 説明 |
|---|---|---|
| Border | color | 罫線の色を指定します。 |
| location | 境界線の位置を取得します。 | |
| type | 罫線の種類を指定します。 | |
| visible | 境界線を表示するかどうかを指定します。 | |
| width | 罫線の幅を指定します。 | |
| BorderCollection | getByLocation(borderLocation: Word.BorderLocation.top |Word.BorderLocation.left |Word.BorderLocation.bottom |Word.BorderLocation.right |Word.BorderLocation.insideHorizontal |Word.BorderLocation.insideVertical |"top" |"左" |"Bottom" |"右" |"InsideHorizontal" |"InsideVertical") | 指定した場所の境界線を取得します。 |
| getFirst() | このコレクションの最初の境界線を取得します。 | |
| getFirstOrNullObject() | このコレクションの最初の境界線を取得します。 | |
| getItem(index: number) | コレクション内のインデックスによって Border オブジェクトを取得します。 |
|
| insideBorderColor | 内側の境界線の 24 ビット カラーを指定します。 | |
| insideBorderType | 内側の罫線の種類を指定します。 | |
| insideBorderWidth | 内側の境界線の幅を指定します。 | |
| items | このコレクション内に読み込まれた子アイテムを取得します。 | |
| outsideBorderColor | 外側の境界線の 24 ビット色を指定します。 | |
| outsideBorderType | 外側の罫線の種類を指定します。 | |
| outsideBorderWidth | 外側の境界線の幅を指定します。 | |
| ドキュメント | compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions) | 指定された文書と別の文書を比較して、変更箇所を示す変更履歴を表示します。 |
| importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior) | JSON 形式の文字列からスタイルをインポートします。 | |
| DocumentCompareOptions | addToRecentFiles | 指定した場合は、[ ファイル ] メニューの最近使用したファイルの一覧にドキュメントを追加するかどうかを指定します。 |
| authorName | 指定した場合は、比較によって生成された相違点に関連付けられたレビューアー名を指定します。 | |
| compareTarget | 指定する場合は、比較の対象ドキュメントを指定します。 | |
| detectFormatChanges | 指定した場合は、比較にフォーマット変更の検出を含める必要があるかどうかを指定します。 | |
| ignoreAllComparisonWarnings | 指定された場合、ユーザーに問題を通知せずにドキュメントを比較するかどうかを指定します。 | |
| removeDateAndTime | 指定した場合、返された Document オブジェクトの変更履歴から日付とタイムスタンプ情報を削除するかどうかを指定します。 |
|
| removePersonalInformation | 指定した場合、返される Document オブジェクトのコメント、リビジョン、およびプロパティ ダイアログ ボックスからすべてのユーザー情報を削除するかどうかを指定します。 |
|
| Field | showCodes | 指定したフィールドのフィールド コードを表示するかどうかを指定します。 |
| InlinePicture | imageFormat | インライン イメージの形式を取得します。 |
| List | getLevelFont(level: number) | リスト内の指定レベルの箇条書き、番号、または画像のフォントを取得します。 |
| getLevelPicture(level: number) | リスト内の指定レベルで、Base64 でエンコードされた画像の文字列表現を取得します。 | |
| resetLevelFont(level: number, resetFontName?: boolean) | 箇条書き、番号、または図のフォントを一覧の指定レベルでリセットします。 | |
| setLevelPicture(level: number, base64EncodedImage?: string) | リスト内の指定したレベルで画像を設定します。 | |
| ListLevel | 配置 | リスト レベルの水平方向の配置を指定します。 |
| font |
ListLevel オブジェクトの文字書式を表す Font オブジェクトを取得します。 |
|
| linkedStyle |
ListLevel オブジェクトにリンクされるスタイルの名前を指定します。 |
|
| numberFormat | リスト レベルの数値の表示形式を指定します。 | |
| numberPosition |
ListLevel オブジェクトの番号または箇条書きの位置 (ポイント単位) を指定します。 |
|
| numberStyle |
ListLevel オブジェクトの数値スタイルを指定します。 |
|
| resetOnHigher | 1 から番号付けを再開する前に表示する必要があるリスト レベルを指定します。 | |
| startAt |
ListLevel オブジェクトの開始番号を指定します。 |
|
| tabPosition |
ListLevel オブジェクトのタブ位置を指定します。 |
|
| textPosition |
ListLevelオブジェクトの折り返しテキストの 2 行目の位置をポイント単位で指定します。 |
|
| trailingCharacter | リスト レベルの数値の後に挿入される文字を指定します。 | |
| ListLevelCollection | getFirst() | このコレクション内の最初のリスト レベルを取得します。 |
| getFirstOrNullObject() | このコレクション内の最初のリスト レベルを取得します。 | |
| items | このコレクション内に読み込まれた子アイテムを取得します。 | |
| ListTemplate | listLevels | リスト テンプレートのすべてのレベルを表す ListLevelCollection オブジェクトを取得します。 |
| outlineNumbered | リスト テンプレートにアウトライン番号を付けるかどうかを指定します。 | |
| Shading | foregroundPatternColor | オブジェクトの前景の色を指定します。 |
| texture | オブジェクトのシェーディング テクスチャを指定します。 | |
| スタイル | borders | スタイルのすべての罫線を表す BorderCollection オブジェクトを指定します。 |
| listTemplate | スタイルのリスト書式を表す ListTemplate オブジェクトを取得します。 |
|
| TableRow | insertContentControl() | 行にコンテンツ コントロールを挿入します。 |
| TableStyle | 配置 | ページ余白に対する表の配置を指定します。 |
| allowBreakAcrossPage | スタイルで書式設定された表の行をページ間で改ページするかどうかを指定します。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins