Word JavaScript プレビュー API
新しい Word JavaScript API は、最初に "プレビュー" で導入され、十分なテストが行われ、ユーザーのフィードバックが取得された後に、特定の番号付き要件セットの一部になります。
重要
次の Word プレビュー API は、次のプラットフォームで使用できる場合があることに注意してください。
- Word on Windows
- Word on Mac
現在、iPad では Word プレビュー API はサポートされていません。 ただし、Word on the web では複数の API を使用することもできます。 Word on the web でのみ使用できる API については、 Web 専用 API の一覧を参照してください。
注:
プレビュー API は変更されることがあります。運用環境での使用は意図されていません。 試用はテスト環境と開発環境に限定することをお勧めします。 運用環境やビジネス上重要なドキュメントでプレビュー API を使用しないでください。
プレビュー API を使用するには:
- Office.js コンテンツ配信ネットワーク (CDN) から Office JavaScript API ライブラリのプレビュー バージョンを使用する必要があります。 TypeScript コンパイルおよび IntelliSense の 型定義ファイルは CDN で見つかり、DefinitelyTyped にあります。 これらの型は を使用して
npm install --save-dev @types/office-js-preview
インストールできます (以前にインストールした場合は、 の@types/office-js
型を必ず削除してください)。 - 最新の Office ビルドにアクセスするには、 Microsoft 365 Insider プログラム に参加する必要がある場合があります。
API リスト
次の表に、現在プレビュー中の Word JavaScript API の一覧を示します。ただし、 Web 上の Word でのみ使用できる API を除きます。 すべての Word JavaScript API (プレビュー API と以前にリリースされた API を含む) の完全な一覧については、 すべての Word JavaScript API を参照してください。
クラス | フィールド | 説明 |
---|---|---|
Body | insertContentControl(contentControlType?: Word.ContentControlType.richText |Word.ContentControlType.plainText |Word.ContentControlType.checkBox |Word.ContentControlType.dropDownList |Word.ContentControlType.comboBox |"RichText" |"PlainText" |"CheckBox" |"DropDownList" |"ComboBox") | Body オブジェクトをコンテンツ コントロールでラップします。 |
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 | 外側の罫線の幅を指定します。 | |
ComboBoxContentControl | addListItem(displayText: string, value?: string, index?: number) | このコンボ ボックス コンテンツ コントロールに新しいリスト アイテムを追加し、Word.ContentControlListItem オブジェクトを返します。 |
deleteAllListItems() | このコンボ ボックス コンテンツ コントロールのすべてのリスト 項目を削除します。 | |
listItems | コンボ ボックス コンテンツ コントロール内のリスト 項目のコレクションを取得します。 | |
ContentControl | comboBoxContentControl | コンテンツ コントロールの種類が 'ComboBox' の場合は、コンボ ボックスに関連するデータを指定します。 |
dropDownListContentControl | コンテンツ コントロールの種類が 'DropDownList' の場合は、ドロップダウン リストに関連するデータを指定します。 | |
resetState() | コンテンツ コントロールの状態をリセットします。 | |
setState(contentControlState: Word.ContentControlState) | コンテンツ コントロールの状態を設定します。 | |
ContentControlListItem | delete() | リスト アイテムを削除します。 |
displayText | ドロップダウン リストまたはコンボ ボックス コンテンツ コントロールのリスト アイテムの表示テキストを指定します。 | |
index | リスト 項目のコレクション内のコンテンツ コントロールリストアイテムのインデックス位置を指定します。 | |
select() | リスト アイテムを選択し、コンテンツ コントロールのテキストをリスト アイテムの値に設定します。 | |
value | ドロップダウン リストまたはコンボ ボックス コンテンツ コントロールのリスト アイテムのプログラム値を指定します。 | |
ContentControlListItemCollection | getFirst() | このコレクション内の最初のリスト アイテムを取得します。 |
getFirstOrNullObject() | このコレクション内の最初のリスト アイテムを取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
ドキュメント | compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions) | 指定された文書と別の文書を比較して、変更箇所を示す変更履歴を表示します。 |
DocumentCompareOptions | addToRecentFiles | True は、[ ファイル] メニューの最近使用したファイルの一覧にドキュメントを追加します。 |
authorName | 比較によって変更を加える校閲者の名前を指定します。 | |
compareTarget | 比較対象の文書です。 | |
detectFormatChanges | 場合は true。 (既定値) の形式の変更の検出を含むように比較します。 | |
ignoreAllComparisonWarnings | 問題をユーザーに通知することがなく文書を比較する 場合は true です。 | |
removeDateAndTime | True は、取得した Document オブジェクト内の変更履歴から日付と時刻のタイムスタンプ情報を削除します。 | |
removePersonalInformation | True を指定すると、返された Document オブジェクトのコメント、リビジョン、およびプロパティ ダイアログ ボックスからすべてのユーザー情報が削除されます。 | |
DropDownListContentControl | addListItem(displayText: string, value?: string, index?: number) | このドロップダウン リスト コンテンツ コントロールに新しいリスト アイテムを追加し、Word.ContentControlListItem オブジェクトを返します。 |
deleteAllListItems() | このドロップダウン リスト コンテンツ コントロールのすべてのリスト 項目を削除します。 | |
listItems | ドロップダウン リスト コンテンツ コントロールのリスト 項目のコレクションを取得します。 | |
Field | showCodes | 指定したフィールドのフィールド コードを表示するかどうかを指定します。 |
フォント | hidden | フォントが非表示としてタグ付けされているかどうかを示す値を指定します。 |
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 オブジェクトにアウトライン番号を付けするかどうかを指定します。 | |
Paragraph | insertContentControl(contentControlType?: Word.ContentControlType.richText |Word.ContentControlType.plainText |Word.ContentControlType.checkBox |Word.ContentControlType.dropDownList |Word.ContentControlType.comboBox |"RichText" |"PlainText" |"CheckBox" |"DropDownList" |"ComboBox") | Paragraph オブジェクトをコンテンツ コントロールでラップします。 |
Range | insertContentControl(contentControlType?: Word.ContentControlType.richText |Word.ContentControlType.plainText |Word.ContentControlType.checkBox |Word.ContentControlType.dropDownList |Word.ContentControlType.comboBox |"RichText" |"PlainText" |"CheckBox" |"DropDownList" |"ComboBox") | Range オブジェクトをコンテンツ コントロールでラップします。 |
Shading | foregroundPatternColor | オブジェクトの前景の色を指定します。 |
テクスチャー | オブジェクトのシェーディング テクスチャを指定します。 | |
スタイル | borders | 指定したスタイルのすべての罫線を表す BorderCollection オブジェクトを指定します。 |
description | 指定したスタイルの説明を取得します。 | |
listTemplate | 指定した Style オブジェクトのリストの書式設定を表す ListTemplate オブジェクトを取得します。 | |
TableRow | insertContentControl() | 行にコンテンツ コントロールを挿入します。 |
TableStyle | アラインメント | ページ余白に対するテーブルの配置を指定します。 |
allowBreakAcrossPage | 指定したスタイルで書式設定されたテーブル内の行をページ間で区切るかどうかを指定します。 |
Web 専用 API リスト
次の表に、Word on the web でのみプレビュー段階にある Word JavaScript API の一覧を示します。 すべての Word JavaScript API (プレビュー API と以前にリリースされた API を含む) の完全な一覧については、 すべての Word JavaScript API を参照してください。
クラス | フィールド | 説明 |
---|---|---|
Body | onCommentAdded | 新しいコメントが追加されたときに発生します。 |
onCommentChanged | コメントまたはその応答が変更されたときに発生します。 | |
onCommentDeleted | コメントが削除されたときに発生します。 | |
onCommentDeselected | コメントの選択が解除されたときに発生します。 | |
onCommentSelected | コメントが選択されたときに発生します。 | |
CommentDetail | id | このコメントの ID を表します。 |
replyIds | このコメントに対する応答の ID を表します。 | |
CommentEventArgs | changeType | コメント変更イベントのトリガー方法を表します。 |
commentDetails | 関連するコメントの ID と応答 ID を含む CommentDetail 配列を取得します。 | |
source | イベントのソース。 | |
type | イベントの種類。 | |
ContentControl | onCommentAdded | 新しいコメントが追加されたときに発生します。 |
onCommentChanged | コメントまたはその応答が変更されたときに発生します。 | |
onCommentDeselected | コメントの選択が解除されたときに発生します。 | |
onCommentSelected | コメントが選択されたときに発生します。 | |
Paragraph | onCommentAdded | 新しいコメントが追加されたときに発生します。 |
onCommentChanged | コメントまたはその応答が変更されたときに発生します。 | |
onCommentDeleted | コメントが削除されたときに発生します。 | |
onCommentDeselected | コメントの選択が解除されたときに発生します。 | |
onCommentSelected | コメントが選択されたときに発生します。 | |
Range | onCommentAdded | 新しいコメントが追加されたときに発生します。 |
onCommentChanged | コメントまたはその応答が変更されたときに発生します。 | |
onCommentDeselected | コメントの選択が解除されたときに発生します。 | |
onCommentSelected | コメントが選択されたときに発生します。 |
関連項目
Office Add-ins
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示