Word JavaScript API 1.3 の新機能

  • [アーティクル]

WordApi 1.3 では、コンテンツ コントロールとドキュメント レベルの設定のサポートがさらに追加されました。

API リスト

次の表は、Word JavaScript API 要件セット 1.3 の API の一覧です。 JavaScript API 要件セット 1.3 以前Wordサポートされているすべての API の API リファレンス ドキュメントを表示するには、要件セット 1.3 以前の API のWordに関するページを参照してください。

クラス フィールド 説明
Application createDocument(base64File?: string) オプションの Base64 でエンコードされた .docx ファイルを使用して、新しいドキュメントを作成します。
Body getRange(rangeLocation?: Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |Word。RangeLocation.after |Word。RangeLocation.content |"全体" |"Start" |"End" |"After" |"Content") 範囲として、本文全体、あるいは本文の開始点または終了点を取得します。
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start |Word。InsertLocation.end |"Start" |"End", values?: string[][]) 指定した数の行と列を含むテーブルを挿入します。
lists 本文に含まれるリスト オブジェクトのコレクションを取得します。
parentBody 本文の親の本文を取得します。
parentBodyOrNullObject 本文の親の本文を取得します。
parentContentControlOrNullObject 本文を含むコンテンツ コントロールを取得します。
parentSection 本文の親セクションを取得します。
parentSectionOrNullObject 本文の親セクションを取得します。
styleBuiltIn 本文の組み込みスタイル名を指定します。
テーブル 本文に含まれるテーブル オブジェクトのコレクションを取得します。
type 本文の種類を取得します。
ContentControl getRange(rangeLocation?: Word。RangeLocation |"全体" |"Start" |"End" |"Before" |"After" |"Content") 範囲として、コンテンツ コントロール全体、あるいはコンテンツ コントロールの開始点または終了点を取得します。
getTextRanges(endingMarks: string[], trimSpacing?: boolean) 句読点やその他の終了記号を使用して、コンテンツ コントロール内のテキスト範囲を取得します。
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start |Word。InsertLocation.end |Word。InsertLocation.before |Word。InsertLocation.after |"Start" |"End" |"Before" |"After", values?: string[][]) 指定した数の行と列を含むテーブルを、コンテンツ コントロール内またはコンテンツ コントロールの横に挿入します。
lists コンテンツ コントロールに含まれるリスト オブジェクトのコレクションを取得します。
parentBody コンテンツ コントロールの親の本文を取得します。
parentContentControlOrNullObject コンテンツ コントロールを含むコンテンツ コントロールを取得します。
parentTable コンテンツ コントロールを含むテーブルを取得します。
parentTableCell コンテンツ コントロールを含むテーブル セルを取得します。
parentTableCellOrNullObject コンテンツ コントロールを含むテーブル セルを取得します。
parentTableOrNullObject コンテンツ コントロールを含むテーブルを取得します。
split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean) 区切り記号を使用して、コンテンツ コントロールを子の範囲に分割します。
styleBuiltIn コンテンツ コントロールの組み込みスタイル名を指定します。
サブタイプ コンテンツ コントロールのサブタイプを取得します。
テーブル コンテンツ コントロールに含まれるテーブル オブジェクトのコレクションを取得します。
ContentControlCollection getByIdOrNullObject(id: number) コンテンツ コントロールの識別子によってコンテンツ コントロールを取得します。
getByTypes(types: Word。ContentControlType[]) 指定した型を持つコンテンツ コントロールを取得します。
getFirst() このコレクション内の最初のコンテンツ コントロールを取得します。
getFirstOrNullObject() このコレクション内の最初のコンテンツ コントロールを取得します。
CustomProperty delete() カスタム プロパティを削除します。
key カスタム プロパティのキーを取得します。
type カスタム プロパティの値の型を取得します。
value カスタム プロパティの値を指定します。
CustomPropertyCollection add(key: string, value: any) 新しいカスタム プロパティを作成、または既存のカスタム プロパティを設定します。
deleteAll() このコレクション内のすべてのカスタム プロパティを削除します。
getCount() カスタム プロパティの数を取得します。
getItem(key: string) キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。
getItemOrNullObject(key: string) キーを使用してカスタム プロパティ オブジェクトを取得します。大文字と小文字は区別されません。
items このコレクション内に読み込まれた子アイテムを取得します。
ドキュメント プロパティ ドキュメントのプロパティを取得します。
DocumentCreated Open() ドキュメントを開きます。
DocumentProperties Applicationname ドキュメントのアプリケーション名を取得します。
著者 ドキュメントの作成者を指定します。
カテゴリ ドキュメントのカテゴリを指定します。
comments ドキュメントのコメントを指定します。
company ドキュメントの会社を指定します。
creationDate ドキュメントの作成日を取得します。
customProperties ドキュメントのカスタム プロパティのコレクションを取得します。
format ドキュメントの形式を指定します。
キーワード ドキュメントのキーワードを指定します。
lastAuthor ドキュメントの最後の作成者を取得します。
lastPrintDate ドキュメントを最後に印刷した日を取得します。
lastSaveTime ドキュメントを最後に保存した時刻を取得します。
上司 ドキュメントのマネージャーを指定します。
revisionNumber ドキュメントのリビジョン番号を取得します。
セキュリティ ドキュメントのセキュリティ設定を取得します。
subject ドキュメントの件名を指定します。
template ドキュメントのテンプレートを取得します。
title ドキュメントのタイトルを指定します。
InlinePicture getNext() 次のインライン画像を取得します。
getNextOrNullObject() 次のインライン画像を取得します。
getRange(rangeLocation?: Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |"全体" |"Start" |"End") 範囲として、画像、あるいは画像の開始点または終了点を取得します。
parentContentControlOrNullObject インライン画像を含むコンテンツ コントロールを取得します。
parentTable インライン イメージを含むテーブルを取得します。
parentTableCell インライン イメージを含むテーブルのセルを取得します。
parentTableCellOrNullObject インライン イメージを含むテーブルのセルを取得します。
parentTableOrNullObject インライン イメージを含むテーブルを取得します。
InlinePictureCollection getFirst() このコレクション内の最初のインライン イメージを取得します。
getFirstOrNullObject() このコレクション内の最初のインライン イメージを取得します。
List getLevelParagraphs(level: number) リスト内の指定したレベルで発生する段落を取得します。
getLevelString(level: number) 指定したレベルの箇条書き、数値、または図を文字列として取得します。
id リストの ID を取得します。
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start |Word。InsertLocation.end |Word。InsertLocation.before |Word。InsertLocation.after |"Start" |"End" |"Before" |"After") 指定した位置に、段落を挿入します。
levelExistences リストに 9 つのレベルがそれぞれ存在するかどうかを確認します。
levelTypes リスト内の 9 レベルのすべての種類を取得します。
paragraphs リスト内の段落を取得します。
setLevelAlignment(level: number, alignment: Word.配置) 箇条書き、数値、または図の配置を、リスト内の指定されたレベルに設定します。
setLevelBullet(level: number, listBullet: Word.ListBullet,charCode?: number, fontName?: string) リスト内の指定したレベルで行頭文字の書式を設定します。
setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number) リスト内の指定したレベルの 2 つのインデントを設定します。
setLevelNumbering(level: number, listNumbering: Word.ListNumbering、formatString?: 配列<文字列 | number>) リスト内の指定したレベルで番号付け書式を設定します。
setLevelStartingNumber(level: number, startingNumber: number) リスト内の指定したレベルで開始番号を設定します。
ListCollection getById(id: number) 識別子を使用してリストを取得します。
getByIdOrNullObject(id: number) 識別子を使用してリストを取得します。
getFirst() このコレクション内の最初のリストを取得します。
getFirstOrNullObject() このコレクション内の最初のリストを取得します。
getItem(id: number) ID で list オブジェクトを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
ListItem getAncestor(parentOnly?: boolean) リスト アイテムの親、または親が存在しない場合は最も近い先祖を取得します。
getAncestorOrNullObject(parentOnly?: boolean) リスト アイテムの親、または親が存在しない場合は最も近い先祖を取得します。
getDescendants(directChildrenOnly?: boolean) リスト アイテムのすべての子孫のリスト アイテムを取得します。
level リスト内の項目のレベルを指定します。
listString リスト アイテムの箇条書き、数値、または図を文字列として取得します。
siblingIndex 兄弟を基準にしてリスト アイテムの注文番号を取得します。
Paragraph attachToList(listId: number, level: number) 指定したレベルで段落を既存のリストに結合させます。
detachFromList() 段落がリスト アイテムである場合は、この段落をリストから移動します。
getNext() 次の段落を取得します。
getNextOrNullObject() 次の段落を取得します。
getPrevious() 前の段落を取得します。
getPreviousOrNullObject() 前の段落を取得します。
getRange(rangeLocation?: Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |Word。RangeLocation.after |Word。RangeLocation.content |"全体" |"Start" |"End" |"After" |"Content") 段落全体、あるいは段落の開始点または終了点を範囲として取得します。
getTextRanges(endingMarks: string[], trimSpacing?: boolean) 句読点やその他の終了記号を使用して、段落内のテキスト範囲を取得します。
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before |Word。InsertLocation.after |"Before" |"After", values?: string[][]) 指定した数の行と列を含むテーブルを挿入します。
isLastParagraph 段落がその親の本文内の最後の段落であることを示します。
isListItem 段落がリスト アイテムであるかどうかを確認します。
リスト この段落が属するリストを取得します。
listItem 段落の ListItem を取得します。
listItemOrNullObject 段落の ListItem を取得します。
listOrNullObject この段落が属するリストを取得します。
parentBody 段落の親の本文を取得します。
parentContentControlOrNullObject 段落を格納しているコンテンツ コントロールを取得します。
parentTable 段落を含むテーブルを取得します。
parentTableCell 段落を含むテーブルのセルを取得します。
parentTableCellOrNullObject 段落を含むテーブルのセルを取得します。
parentTableOrNullObject 段落を含むテーブルを取得します。
split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean) 区切り記号を使用して、段落を子の範囲に分割します。
startNewList() この段落を含む新しいリストを開始します。
styleBuiltIn 段落の組み込みスタイル名を指定します。
tableNestingLevel 段落のテーブルのレベルを取得します。
ParagraphCollection getFirst() このコレクション内の最初の段落を取得します。
getFirstOrNullObject() このコレクション内の最初の段落を取得します。
getLast() このコレクション内の最後の段落を取得します。
getLastOrNullObject() このコレクション内の最後の段落を取得します。
Range compareLocationWith(range: Word。範囲) この範囲の場所を別の範囲の場所と比較します。
expandTo(range: Word。範囲) 別の範囲を対象にするために、いずれかの方向でこの範囲から拡張する新しい範囲を返します。
expandToOrNullObject(range: Word。範囲) 別の範囲を対象にするために、いずれかの方向でこの範囲から拡張する新しい範囲を返します。
getHyperlinkRanges() 範囲内のハイパーリンクの子の範囲を取得します。
getNextTextRange(endingMarks: string[], trimSpacing?: boolean) 句読点やその他の終了記号を使用して、次のテキスト範囲を取得します。
getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean) 句読点やその他の終了記号を使用して、次のテキスト範囲を取得します。
getRange(rangeLocation?: Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |Word。RangeLocation.after |Word。RangeLocation.content |"全体" |"Start" |"End" |"After" |"Content") 範囲の複製を作成するか、新しい範囲として開始点または終了点を取得します。
getTextRanges(endingMarks: string[], trimSpacing?: boolean) 句読点やその他の終了記号を使用して、範囲内のテキストの子範囲を取得します。
hyperlink 範囲内の最初のハイパーリンクを取得するか、または範囲にハイパーリンクを設定します。
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before |Word。InsertLocation.after |"Before" |"After", values?: string[][]) 指定した数の行と列を含むテーブルを挿入します。
intersectWith(range: Word。範囲) 別の範囲とこの範囲の交点として、新しい範囲を返します。
intersectWithOrNullObject(range: Word。範囲) 別の範囲とこの範囲の交点として、新しい範囲を返します。
isEmpty 範囲の長さが 0 であるかどうかを確認します。
lists 範囲内のリスト オブジェクトのコレクションを取得します。
parentBody 範囲の親の本文を取得します。
parentContentControlOrNullObject 範囲を格納するコンテンツ コントロールを取得します。
parentTable 範囲を含むテーブルを取得します。
parentTableCell 範囲を含むテーブルのセルを取得します。
parentTableCellOrNullObject 範囲を含むテーブルのセルを取得します。
parentTableOrNullObject 範囲を含むテーブルを取得します。
split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean) 区切り記号を使用して、範囲を子の範囲に分割します。
styleBuiltIn 範囲の組み込みスタイル名を指定します。
テーブル 範囲内のテーブル オブジェクトのコレクションを取得します。
RangeCollection getFirst() このコレクション内の最初の範囲を取得します。
getFirstOrNullObject() このコレクション内の最初の範囲を取得します。
RequestContext application [Api set: WordApi 1.3] *
Section getNext() 次のセクションを取得します。
getNextOrNullObject() 次のセクションを取得します。
SectionCollection getFirst() このコレクション内の最初のセクションを取得します。
getFirstOrNullObject() このコレクション内の最初のセクションを取得します。
表 addColumns(insertLocation: Word。InsertLocation.start |Word。InsertLocation.end |"Start" |"End", columnCount: number, values?: string[][]) 最初または最後の既存の列をテンプレートとして使用して、テーブルの最初または最後に列を追加します。
addRows(insertLocation: Word。InsertLocation.start |Word。InsertLocation.end |"Start" |"End", rowCount: number, values?: string[][]) 最初または最後の既存の行をテンプレートとして使用して、テーブルの最初または最後に行を追加します。
配置 ページ列に対するテーブルの配置を指定します。
autoFitWindow() テーブルの列をウィンドウの幅に合わせて自動調整します。
clear() テーブルの内容をクリアします。
delete() テーブル全体を削除します。
deleteColumns(columnIndex: number, columnCount?: number) 特定の列を削除します。
deleteRows(rowIndex: number, rowCount?: number) 特定の行を削除します。
distributeColumns() 列の幅を揃えます。
font フォントを取得します。
getBorder(borderLocation: Word。BorderLocation) 指定した罫線の罫線スタイルを取得します。
getCell(rowIndex: number, cellIndex: number) 指定された行と列のテーブル セルを取得します。
getCellOrNullObject(rowIndex: number, cellIndex: number) 指定された行と列のテーブル セルを取得します。
getCellPadding(cellPaddingLocation: Word。CellPaddingLocation) セル内のスペースをポイント単位で取得します。
getNext() 次のテーブルを取得します。
getNextOrNullObject() 次のテーブルを取得します。
getParagraphAfter() テーブルの後の段落を取得します。
getParagraphAfterOrNullObject() テーブルの後の段落を取得します。
getParagraphBefore() テーブルの前の段落を取得します。
getParagraphBeforeOrNullObject() テーブルの前の段落を取得します。
getRange(rangeLocation?: Word。RangeLocation.whole |Word。RangeLocation.start |Word。RangeLocation.end |Word。RangeLocation.after |"全体" |"Start" |"End" |"After") このテーブルを含む範囲、あるいはテーブルの開始または終了の範囲を取得します。
headerRowCount ヘッダー行の数を指定します。
horizontalAlignment テーブル内のすべてのセルの水平方向の配置を指定します。
insertContentControl() テーブルにコンテンツ コントロールを挿入します。
insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before |Word。InsertLocation.after |"Before" |"After") 指定した位置に、段落を挿入します。
insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before |Word。InsertLocation.after |"Before" |"After", values?: string[][]) 指定した数の行と列を含むテーブルを挿入します。
isUniform すべてのテーブル行が均一かどうかを示します。
nestingLevel テーブルの入れ子のレベルを取得します。
parentBody テーブルの親の本文を取得します。
parentContentControl テーブルを含むコンテンツ コントロールを取得します。
parentContentControlOrNullObject テーブルを含むコンテンツ コントロールを取得します。
parentTable このテーブルを含むテーブルを取得します。
parentTableCell このテーブルを含むテーブルのセルを取得します。
parentTableCellOrNullObject このテーブルを含むテーブルのセルを取得します。
parentTableOrNullObject このテーブルを含むテーブルを取得します。
行数 表の行数を取得します。
rows すべてのテーブルの行を取得します。
search(searchText: string, searchOptions?: Word。SearchOptions |{ ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) テーブル オブジェクトのスコープで、指定した SearchOptions を使用して検索を実行します。
select(selectionMode?: Word。SelectionMode) テーブル、あるいはテーブルの開始位置または終了位置を選択して、Word の UI に移動します。
setCellPadding(cellPaddingLocation: Word。CellPaddingLocation, cellPadding: number) セル内のスペースをポイント単位で設定します。
shadingColor 網かけの色を指定します。
style テーブルのスタイル名を指定します。
styleBandedColumns テーブルにバンド列があるかどうかを指定します。
styleBandedRows テーブルにバンド行があるかどうかを指定します。
styleBuiltIn テーブルの組み込みスタイル名を指定します。
styleFirstColumn テーブルに特殊なスタイルの最初の列があるかどうかを指定します。
styleLastColumn テーブルに特殊なスタイルの最後の列があるかどうかを指定します。
styleTotalRow テーブルに特殊なスタイルの合計 (最後) 行があるかどうかを指定します。
テーブル 1 レベル深く入れ子にされた子テーブルを取得します。
values 2D JavaScript 配列として、テーブル内のテキスト値を指定します。
verticalAlignment テーブル内のすべてのセルの垂直方向の配置を指定します。
width テーブルの幅をポイント単位で指定します。
TableBorder color 表の罫線の色を指定します。
type テーブルの罫線の種類を指定します。
width 表の罫線の幅をポイント単位で指定します。
TableCell body セルの本文オブジェクトを取得します。
cellIndex その行のセルのインデックスを取得します。
columnWidth セルの列の幅をポイント単位で指定します。
deleteColumn() このセルを含む列を削除します。
deleteRow() このセルを含む行を削除します。
getBorder(borderLocation: Word。BorderLocation) 指定した罫線の罫線スタイルを取得します。
getCellPadding(cellPaddingLocation: Word。CellPaddingLocation) セル内のスペースをポイント単位で取得します。
getNext() 次のセルを取得します。
getNextOrNullObject() 次のセルを取得します。
horizontalAlignment セルの水平方向の配置を指定します。
insertColumns(insertLocation: Word。InsertLocation.before |Word。InsertLocation.after |"Before" |"After", columnCount: number, values?: string[][]) セルの列をテンプレートとして使用して、列をセルの左または右に追加します。
insertRows(insertLocation: Word。InsertLocation.before |Word。InsertLocation.after |"Before" |"After", rowCount: number, values?: string[][]) セルの行をテンプレートとして使用して、行をセルの上または下に挿入します。
parentRow セルの親行を取得します。
parentTable セルの親テーブルを取得します。
rowIndex テーブルのセル行のインデックスを取得します。
setCellPadding(cellPaddingLocation: Word。CellPaddingLocation, cellPadding: number) セル内のスペースをポイント単位で設定します。
shadingColor セルの網かけの色を指定します。
value セルのテキストを指定します。
verticalAlignment セルの垂直方向の配置を指定します。
width セルの幅をポイント単位で取得します。
TableCellCollection getFirst() このコレクション内の最初のテーブル セルを取得します。
getFirstOrNullObject() このコレクション内の最初のテーブル セルを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
TableCollection getFirst() このコレクション内の最初のテーブルを取得します。
getFirstOrNullObject() このコレクション内の最初のテーブルを取得します。
items このコレクション内に読み込まれた子アイテムを取得します。
TableRow cellCount 行のセルの数を取得します。
細胞 セルを取得します。
clear() 行の内容をクリアします。
delete() 行全体を削除します。
font フォントを取得します。
getBorder(borderLocation: Word。BorderLocation) 行のセルの罫線スタイルを取得します。
getCellPadding(cellPaddingLocation: Word。CellPaddingLocation) セル内のスペースをポイント単位で取得します。
getNext() 次の行を取得します。
getNextOrNullObject() 次の行を取得します。
horizontalAlignment 行内のすべてのセルの水平方向の配置を指定します。
insertRows(insertLocation: Word。InsertLocation.before |Word。InsertLocation.after |"Before" |"After", rowCount: number, values?: string[][]) この行をテンプレートとして使用して、行を挿入します。
isHeader 行がヘッダー行であるかどうかを確認します。
parentTable 親テーブルを取得します。
preferredHeight 行の高さをポイント単位で指定します。
rowIndex 親テーブル内の行のインデックスを取得します。
search(searchText: string, searchOptions?: Word。SearchOptions |{ ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) 行のスコープに対して、指定した SearchOptions を使用して検索を実行します。
select(selectionMode?: Word。SelectionMode) 行を選択し、その行に Word の UI を移動します。
setCellPadding(cellPaddingLocation: Word。CellPaddingLocation, cellPadding: number) セル内のスペースをポイント単位で設定します。
shadingColor 網かけの色を指定します。
values 行内のテキスト値を 2D JavaScript 配列として指定します。
verticalAlignment 行内のセルの垂直方向の配置を指定します。
TableRowCollection getFirst() このコレクション内の最初の行を取得します。
getFirstOrNullObject() このコレクション内の最初の行を取得します。
items このコレクション内に読み込まれた子アイテムを取得します。

関連項目