次の方法で共有

JavaScript プレビュー API のWord

  • [アーティクル]

新しいWord JavaScript API は、最初に "プレビュー" で導入され、後で十分なテストが行われ、ユーザー フィードバックが取得された後に、特定の番号付き要件セットの一部になります。

重要

次のWordプレビュー API は、次のプラットフォームで使用できる場合があることに注意してください。

  • Word on Windows
  • Word on Mac

Word プレビュー API は現在、iPad ではサポートされていません。 ただし、Web 上のWordで複数の API を使用することもできます。 web 上のWordでのみ使用できる 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 オブジェクトをコンテンツ コントロールでラップします。
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 このコレクション内に読み込まれた子アイテムを取得します。
ドキュメント compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions) 指定された文書と別の文書を比較して、変更箇所を示す変更履歴を表示します。
DropDownListContentControl addListItem(displayText: string, value?: string, index?: number) このドロップダウン リスト コンテンツ コントロールに新しいリスト アイテムを追加し、Wordを返します。ContentControlListItem オブジェクト。
deleteAllListItems() このドロップダウン リスト コンテンツ コントロールのすべてのリスト 項目を削除します。
listItems ドロップダウン リスト コンテンツ コントロールのリスト 項目のコレクションを取得します。
フォント hidden フォントが非表示としてタグ付けされているかどうかを示す値を指定します。
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 オブジェクトをコンテンツ コントロールでラップします。
スタイル description 指定したスタイルの説明を取得します。

Web 専用 API リスト

次の表に、web 上のWordでのみプレビュー段階にある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 コメントが選択されたときに発生します。

関連項目