WordApi 1.7 では、主に書き込み支援のサポートが追加されました。
重要
注釈 API では、基になるサービスの要件のために適切に動作するためには、Microsoft 365 サブスクリプションが必要です。 詳細については、「 GitHub Issue 4953」を参照してください。
API リスト
次の表は、Word JavaScript API 要件セット 1.7 の API の一覧です。 JavaScript API 要件セット 1.7 以前でサポートされているすべての API の API リファレンス ドキュメントWord表示するには、要件セット 1.7 以前の API のWordに関するページを参照してください。
| クラス | フィールド | 説明 |
|---|---|---|
| Annotation | critiqueAnnotation |
CritiqueAnnotation オブジェクトを取得します。 |
| delete() | 注釈を削除します。 | |
| id |
Annotation オブジェクトの追跡を容易にするために使用する一意識別子を取得します。 |
|
| state | 注釈の状態を取得します。 | |
| AnnotationClickedEventArgs | id | イベントが発生した注釈 ID を指定します。 |
| AnnotationCollection | getFirst() | このコレクション内の最初の注釈を取得します。 |
| getFirstOrNullObject() | このコレクション内の最初の注釈を取得します。 | |
| items | このコレクション内に読み込まれた子アイテムを取得します。 | |
| AnnotationHoveredEventArgs | id | イベントが発生した注釈 ID を指定します。 |
| AnnotationInsertedEventArgs | ids | イベントが発生した注釈 ID を指定します。 |
| AnnotationRemovedEventArgs | ids | イベントが発生した注釈 ID を指定します。 |
| AnnotationSet | 批判 | 批判。 |
| CheckboxContentControl | isChecked | チェック ボックスの現在の状態を指定します。 |
| ContentControl | checkboxContentControl | コンテンツ コントロールの種類が checkBoxされている場合のデータを取得します。 |
| 評論 | colorScheme | 批判の配色を指定します。 |
| length | 段落内の批判の長さを指定します。 | |
| start | 段落内の批判の開始インデックスを指定します。 | |
| CritiqueAnnotation | accept() | 批判を受け入れます。 |
| 評論 | 注釈が挿入されたときに渡された批判を取得します。 | |
| range | 注釈が付けられたテキストの範囲を取得します。 | |
| reject() | 批判を拒否します。 | |
| ドキュメント | getAnnotationById(id: string) | ID で注釈を取得します。 |
| onAnnotationClicked | ユーザーが注釈をクリック (または Alt + Down を使用して選択) したときに発生します。 | |
| onAnnotationHovered | ユーザーが注釈の上にカーソルを合わせると発生します。 | |
| onAnnotationInserted | ユーザーが 1 つ以上の注釈を追加するときに発生します。 | |
| onAnnotationRemoved | ユーザーが 1 つ以上の注釈を削除するときに発生します。 | |
| search(searchText: string, searchOptions?: Word。SearchOptions |{ ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) | 指定した検索オプションを使用して、ドキュメント全体のスコープで検索を実行します。 | |
| GetTextOptions | includeHiddenText | 指定した場合は、 Paragraph.getText メソッドの結果に非表示のテキストを含めるかどうかを指定します。 |
| includeTextMarkedAsDeleted | 指定した場合は、 Paragraph.getText メソッドの結果に削除済みとしてマークされたテキストを含めるかどうかを指定します。 |
|
| InsertFileOptions | importDifferentOddEvenPages | 指定した場合は、ヘッダーとフッターの異なる奇数ページと偶数ページ設定をソース ドキュメントからインポートするかどうかを指定します。 |
| Paragraph | getAnnotations() | この Paragraph オブジェクトに設定された注釈を取得します。 |
| getText(options?: Word。GetTextOptions |{ IncludeHiddenText?: Boolean IncludeTextMarkedAsDeleted?: boolean }) | 段落のテキストを返します。 | |
| insertAnnotations(annotations: Word。AnnotationSet) | この Paragraph オブジェクトに注釈を挿入します。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins