Word JavaScript API デスクトップのみの要件セット 1.1
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 と WordApiHiddenDocument 1.5 要件セットのスーパーセットです。
推奨される使用方法
WordApiDesktop API は Windows、Mac、iPad のWordでのみサポートされるため、これらの API を呼び出す前に要件セットがサポートされている場合、アドインはチェックする必要があります。 これにより、サポートされていないプラットフォームでデスクトップのみの API を使用しようとするのを回避できます。
if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.1")) {
// Any API exclusive to the 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" |"Left" |"Bottom" |"Right" |"InsideHorizontal" |"InsideVertical") | 指定した場所を持つ罫線を取得します。 |
| getFirst() | このコレクションの最初の罫線を取得します。 | |
| getFirstOrNullObject() | このコレクションの最初の罫線を取得します。 | |
| getItem(index: number) | コレクション内のインデックスで Border オブジェクトを取得します。 | |
| insideBorderColor | 内側の罫線の 24 ビットの色を指定します。 | |
| insideBorderType | 内側の罫線の罫線の種類を指定します。 | |
| insideBorderWidth | 内側の罫線の幅を指定します。 | |
| items | このコレクション内に読み込まれた子アイテムを取得します。 | |
| outsideBorderColor | 外側の罫線の 24 ビットの色を指定します。 | |
| outsideBorderType | 外側の罫線の罫線の種類を指定します。 | |
| outsideBorderWidth | 外側の罫線の幅を指定します。 | |
| ドキュメント | compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions) | 指定された文書と別の文書を比較して、変更箇所を示す変更履歴を表示します。 |
| DocumentCompareOptions | addToRecentFiles | True は、[ ファイル] メニューの最近使用したファイルの一覧にドキュメントを追加します。 |
| authorName | 比較によって変更を加える校閲者の名前を指定します。 | |
| compareTarget | 比較対象の文書です。 | |
| detectFormatChanges | 場合は true。 (既定値) の形式の変更の検出を含むように比較します。 | |
| ignoreAllComparisonWarnings | 問題をユーザーに通知することがなく文書を比較する 場合は true です。 | |
| removeDateAndTime | True は、取得した Document オブジェクト内の変更履歴から日付と時刻のタイムスタンプ情報を削除します。 | |
| removePersonalInformation | True を指定すると、返された 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 | 指定したオブジェクトの文字書式を表す Font オブジェクトを取得します。 | |
| linkedStyle | 指定したリスト レベル オブジェクトにリンクされているスタイルの名前を指定します。 | |
| numberFormat | 指定したリスト レベルの数値形式を指定します。 | |
| numberPosition | 指定したリスト レベル オブジェクトの数値または箇条書きの位置 (ポイント単位) を指定します。 | |
| numberStyle | リスト レベル オブジェクトの数値スタイルを指定します。 | |
| resetOnHigher | 指定したリスト レベルが 1 で番号付けを再開する前に表示する必要があるリスト レベルを指定します。 | |
| startAt | 指定したリスト レベル オブジェクトの開始番号を指定します。 | |
| tabPosition | 指定したリスト レベル オブジェクトのタブ位置を指定します。 | |
| textPosition | 指定したリスト レベル オブジェクトの折り返しテキストの 2 行目の位置 (ポイント単位) を指定します。 | |
| trailingCharacter | 指定したリスト レベルの数値の後に挿入される文字を指定します。 | |
| ListLevelCollection | getFirst() | このコレクションの最初のリスト レベルを取得します。 |
| getFirstOrNullObject() | このコレクションの最初のリスト レベルを取得します。 | |
| items | このコレクション内に読み込まれた子アイテムを取得します。 | |
| ListTemplate | listLevels | 指定した ListTemplate のすべてのレベルを表す ListLevels コレクションを取得します。 |
| outlineNumbered | 指定した ListTemplate オブジェクトにアウトライン番号を付けするかどうかを指定します。 | |
| Shading | foregroundPatternColor | オブジェクトの前景の色を指定します。 |
| テクスチャー | オブジェクトのシェーディング テクスチャを指定します。 | |
| スタイル | borders | 指定したスタイルのすべての罫線を表す BorderCollection オブジェクトを指定します。 |
| listTemplate | 指定した Style オブジェクトのリストの書式設定を表す ListTemplate オブジェクトを取得します。 | |
| TableRow | insertContentControl() | 行にコンテンツ コントロールを挿入します。 |
| TableStyle | アラインメント | ページ余白に対するテーブルの配置を指定します。 |
| allowBreakAcrossPage | 指定したスタイルで書式設定されたテーブル内の行をページ間で区切るかどうかを指定します。 |
関連項目
Office Add-ins