Word JavaScript API 1.4 の新機能
WordApi 1.4 では、ブックマーク、変更の追跡、コメント、カスタム XML パーツ、フィールド、テーブル セルのマージと分割のサポートが追加されました。
API リスト
次の表に、Word JavaScript API 要件セット 1.4 の API を示します。 JavaScript API 要件セット 1.4 以前Wordサポートされているすべての API の API リファレンス ドキュメントを表示するには、要件セット 1.4 以前の API のWordに関するページを参照してください。
クラス | フィールド | 説明 |
---|---|---|
Body | fields | 本文内のフィールド オブジェクトのコレクションを取得します。 |
getComments() | 本文に関連付けられているコメントを取得します。 | |
getReviewedText(changeTrackingVersion?: Word。ChangeTrackingVersion) | ChangeTrackingVersion の選択に基づいて、レビューされたテキストを取得します。 | |
コメント | authorEmail | コメント作成者のメール アドレスを取得します。 |
authorName | コメント作成者の名前を取得します。 | |
content | コメントの内容をプレーン テキストとして指定します。 | |
contentRange | コメントのコンテンツ範囲を指定します。 | |
creationDate | コメントの作成日を取得します。 | |
delete() | コメントとその返信を削除します。 | |
getRange() | コメントがあるメインドキュメント内の範囲を取得します。 | |
id | コメントの ID を取得します。 | |
replies | コメントに関連付けられている応答オブジェクトのコレクションを取得します。 | |
reply(replyText: string) | コメント スレッドの末尾に新しい応答を追加します。 | |
解決 | コメント スレッドの状態を指定します。 | |
CommentCollection | getFirst() | コレクション内の最初のコメントを取得します。 |
getFirstOrNullObject() | コレクション内の最初のコメントを取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
CommentContentRange | bold | コメント テキストが太字かどうかを示す値を指定します。 |
hyperlink | 範囲内の最初のハイパーリンクを取得するか、または範囲にハイパーリンクを設定します。 | |
insertText(text: string, insertLocation: Word.InsertLocation |"Replace" |"Start" |"End" |"Before" |"After") | 指定した場所にテキストを挿入します。 | |
isEmpty | 範囲の長さが 0 であるかどうかを確認します。 | |
italic | コメント テキストが斜体かどうかを示す値を指定します。 | |
取り消し 線 | コメント テキストに取り消し線があるかどうかを示す値を指定します。 | |
text | コメント範囲のテキストを取得します。 | |
underline | コメント テキストの下線の種類を示す値を指定します。 | |
CommentReply | authorEmail | コメント返信作成者のメール アドレスを取得します。 |
authorName | コメント返信作成者の名前を取得します。 | |
content | コメント応答の内容を指定します。 | |
contentRange | commentReply のコンテンツ範囲を指定します。 | |
creationDate | コメント応答の作成日を取得します。 | |
delete() | コメント返信を削除します。 | |
id | コメント応答の ID を取得します。 | |
parentComment | この応答の親コメントを取得します。 | |
CommentReplyCollection | getFirst() | コレクション内の最初のコメント応答を取得します。 |
getFirstOrNullObject() | コレクション内の最初のコメント応答を取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
ContentControl | fields | コンテンツ コントロール内のフィールド オブジェクトのコレクションを取得します。 |
getComments() | コンテンツ コントロールに関連付けられているコメントを取得します。 | |
getReviewedText(changeTrackingVersion?: Word。ChangeTrackingVersion) | ChangeTrackingVersion の選択に基づいて、レビューされたテキストを取得します。 | |
CustomXmlPart | delete() | カスタム XML パーツを削除します。 |
deleteAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string) | xpath によって識別される要素から、指定された名前の属性を削除します。 | |
deleteElement(xpath: string, namespaceMappings: { [key: string]: string }) | xpath によって識別される要素を削除します。 | |
getXml() | カスタム XML パーツの完全な XML コンテンツを取得します。 | |
id | カスタム XML パーツの ID を取得します。 | |
insertAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string) | 指定された名前と値を持つ属性を xpath によって識別される要素に挿入します。 | |
insertElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }, index?: number) | 子位置インデックスで xpath によって識別される親要素の下に、指定された XML を挿入します。 | |
namespaceUri | カスタム XML パーツの名前空間 URI を取得します。 | |
query(xpath: string, namespaceMappings: { [key: string]: string }) | カスタム XML パーツの XML コンテンツを照会します。 | |
setXml(xml: string) | カスタム XML パーツの完全な XML コンテンツを設定します。 | |
updateAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string) | xpath によって識別される要素の指定された名前を持つ属性の値を更新します。 | |
updateElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }) | xpath によって識別される要素の XML を更新します。 | |
CustomXmlPartCollection | add(xml: string) | ドキュメントに新しいカスタム XML パーツを追加します。 |
getByNamespace(namespaceUri: string) | 名前空間が指定した名前空間に一致する、カスタム XML パーツの新しい範囲のコレクションを取得します。 | |
getCount() | コレクション内のアイテムの数を取得します。 | |
getItem(id: string) | ID に基づいて、カスタム XML パーツを取得します。 | |
getItemOrNullObject(id: string) | ID に基づいて、カスタム XML パーツを取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
CustomXmlPartScopedCollection | getCount() | コレクション内のアイテムの数を取得します。 |
getItem(id: string) | ID に基づいて、カスタム XML パーツを取得します。 | |
getItemOrNullObject(id: string) | ID に基づいて、カスタム XML パーツを取得します。 | |
getOnlyItem() | コレクションに含まれる項目が 1 つだけの場合、このメソッドはその項目を返します。 | |
getOnlyItemOrNullObject() | コレクションに含まれる項目が 1 つだけの場合、このメソッドはその項目を返します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
ドキュメント | changeTrackingMode | ChangeTracking モードを指定します。 |
customXmlParts | ドキュメント内のカスタム XML パーツを取得します。 | |
deleteBookmark(name: string) | ブックマークが存在する場合は、ドキュメントから削除します。 | |
getBookmarkRange(name: string) | ブックマークの範囲を取得します。 | |
getBookmarkRangeOrNullObject(name: string) | ブックマークの範囲を取得します。 | |
settings | ドキュメント内のアドインの設定を取得します。 | |
Field | code | フィールドのコード命令を取得します。 |
getNext() | 次のフィールドを取得します。 | |
getNextOrNullObject() | 次のフィールドを取得します。 | |
parentBody | フィールドの親本文を取得します。 | |
parentContentControl | フィールドを含むコンテンツ コントロールを取得します。 | |
parentContentControlOrNullObject | フィールドを含むコンテンツ コントロールを取得します。 | |
parentTable | フィールドを含むテーブルを取得します。 | |
parentTableCell | フィールドを含むテーブル セルを取得します。 | |
parentTableCellOrNullObject | フィールドを含むテーブル セルを取得します。 | |
parentTableOrNullObject | フィールドを含むテーブルを取得します。 | |
result | フィールドの結果データを取得します。 | |
FieldCollection | getFirst() | このコレクションの最初のフィールドを取得します。 |
getFirstOrNullObject() | このコレクションの最初のフィールドを取得します。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
Paragraph | fields | 段落内のフィールドのコレクションを取得します。 |
getComments() | 段落に関連付けられているコメントを取得します。 | |
getReviewedText(changeTrackingVersion?: Word。ChangeTrackingVersion) | ChangeTrackingVersion の選択に基づいて、レビューされたテキストを取得します。 | |
Range | fields | 範囲内のフィールド オブジェクトのコレクションを取得します。 |
getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean) | 範囲内のすべてのブックマークまたは範囲の重複する名前を取得します。 | |
getComments() | 範囲に関連付けられているコメントを取得します。 | |
getReviewedText(changeTrackingVersion?: Word。ChangeTrackingVersion) | ChangeTrackingVersion の選択に基づいて、レビューされたテキストを取得します。 | |
insertBookmark(name: string) | 範囲にブックマークを挿入します。 | |
insertComment(commentText: string) | 範囲にコメントを挿入します。 | |
設定 | delete() | 設定を削除します。 |
key | 設定のキーを取得します。 | |
value | 設定の値を指定します。 | |
SettingCollection | add(key: string, value: any) | 新しい設定を作成するか、既存の設定を設定します。 |
deleteAll() | このアドインのすべての設定を削除します。 | |
getCount() | 設定の数を取得します。 | |
getItem(key: string) | キーによって設定オブジェクトを取得します。これは大文字と小文字が区別されます。 | |
getItemOrNullObject(key: string) | キーによって設定オブジェクトを取得します。これは大文字と小文字が区別されます。 | |
items | このコレクション内に読み込まれた子アイテムを取得します。 | |
表 | fields | テーブル内のフィールド オブジェクトのコレクションを取得します。 |
mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number) | 最初のセルと最後のセルで囲まれたセルをマージします。 | |
TableCell | split(rowCount: number, columnCount: number) | セルを指定した数の行と列に分割します。 |
TableRow | fields | テーブル行のフィールド オブジェクトのコレクションを取得します。 |
merge() | 行を 1 つのセルにマージします。 |
関連項目
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
Office Add-ins