Word.Table class

リファレンス

パッケージ:: word

Word ドキュメント内のテーブルを表します。

Extends: OfficeExtension.ClientObject

注釈

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/table-cell-access.yaml

await Word.run(async (context) => {
  // Use a two-dimensional array to hold the initial table values.
  const data = [
    ["Tokyo", "Beijing", "Seattle"],
    ["Apple", "Orange", "Pineapple"]
  ];
  const table = context.document.body.insertTable(2, 3, "Start", data);
  table.styleBuiltIn = Word.BuiltInStyleName.gridTable5Dark_Accent2;
  table.styleFirstColumn = false;

  await context.sync();
});

プロパティ

alignment	ページ列に対するテーブルの配置を指定します。値には、'Left'、'Centered'、または 'Right' を指定できます。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
endnotes	テーブル内の文末脚注のコレクションを取得します。
fields	テーブル内のフィールドオブジェクトのコレクションを取得します。
font	フォントを取得します。これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。
footnotes	テーブル内の脚注のコレクションを取得します。
headerRowCount	ヘッダー行の数を指定します。
horizontalAlignment	テーブル内のすべてのセルの水平方向の配置を指定します。値には、'Left'、'Centered'、'Right'、または 'Justified' を指定できます。
isUniform	すべてのテーブル行が均一かどうかを示します。
nestingLevel	テーブルの入れ子のレベルを取得します。最上位のテーブルのレベルは、レベル 1 です。
parentBody	テーブルの親の本文を取得します。
parentContentControl	テーブルを含むコンテンツコントロールを取得します。 `ItemNotFound`親コンテンツコントロールがない場合は、エラーをスローします。
parentContentControlOrNullObject	テーブルを含むコンテンツコントロールを取得します。親コンテンツコントロールがない場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
parentTable	このテーブルを含むテーブルを取得します。テーブルに `ItemNotFound` 含まれていない場合は、エラーをスローします。
parentTableCell	このテーブルを含むテーブルのセルを取得します。テーブルセルに `ItemNotFound` 含まれていない場合は、エラーをスローします。
parentTableCellOrNullObject	このテーブルを含むテーブルのセルを取得します。テーブルセルに含まれていない場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
parentTableOrNullObject	このテーブルを含むテーブルを取得します。テーブルに含まれていない場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
rowCount	表の行数を取得します。
rows	すべてのテーブルの行を取得します。
shadingColor	網かけの色を指定します。色は、"#RRGGBB" 形式で指定するか、色の名前を使用して指定します。
style	テーブルのスタイル名を指定します。カスタムスタイルとローカライズされたスタイルの名前には、このプロパティを使用します。ロケール間で移植可能な組み込みスタイルを使用するには、"styleBuiltIn" プロパティを参照してください。
styleBandedColumns	テーブルにバンド列があるかどうかを指定します。
styleBandedRows	テーブルにバンド行があるかどうかを指定します。
styleBuiltIn	テーブルの組み込みスタイル名を指定します。ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。カスタムスタイルまたはローカライズされたスタイルの名前を使用するには、"style" プロパティを参照してください。
styleFirstColumn	テーブルに特殊なスタイルの最初の列があるかどうかを指定します。
styleLastColumn	テーブルに特殊なスタイルの最後の列があるかどうかを指定します。
styleTotalRow	テーブルに特殊なスタイルの合計 (最後) 行があるかどうかを指定します。
tables	1 レベル深く入れ子にされた子テーブルを取得します。
values	2D JavaScript 配列として、テーブル内のテキスト値を指定します。
verticalAlignment	テーブル内のすべてのセルの垂直方向の配置を指定します。値には、'Top'、'Center'、または 'Bottom' を指定できます。
width	テーブルの幅をポイント単位で指定します。

メソッド

addColumns(insertLocation, columnCount, values)	最初または最後の既存の列をテンプレートとして使用して、テーブルの最初または最後に列を追加します。これは、統一されたテーブルに適用可能です。指定すると、文字列値は新しく挿入された行に設定されます。
addRows(insertLocation, rowCount, values)	最初または最後の既存の行をテンプレートとして使用して、テーブルの最初または最後に行を追加します。指定すると、文字列値は新しく挿入された行に設定されます。
autoFitWindow()	テーブルの列をウィンドウの幅に合わせて自動調整します。
clear()	テーブルの内容をクリアします。
delete()	テーブル全体を削除します。
deleteColumns(columnIndex, columnCount)	特定の列を削除します。これは、統一されたテーブルに適用可能です。
deleteRows(rowIndex, rowCount)	特定の行を削除します。
distributeColumns()	列の幅を揃えます。これは、統一されたテーブルに適用可能です。
getBorder(borderLocation)	指定した罫線の罫線スタイルを取得します。
getBorder(borderLocationString)	指定した罫線の罫線スタイルを取得します。
getCell(rowIndex, cellIndex)	指定された行と列のテーブルセルを取得します。 `ItemNotFound`指定したテーブルセルが存在しない場合は、エラーをスローします。
getCellOrNullObject(rowIndex, cellIndex)	指定された行と列のテーブルセルを取得します。指定したテーブルセルが存在しない場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getCellPadding(cellPaddingLocation)	セル内のスペースをポイント単位で取得します。
getCellPadding(cellPaddingLocationString)	セル内のスペースをポイント単位で取得します。
getNext()	次のテーブルを取得します。このテーブルが最後の `ItemNotFound` テーブルの場合は、エラーをスローします。
getNextOrNullObject()	次のテーブルを取得します。このテーブルが最後のテーブルの場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getParagraphAfter()	テーブルの後の段落を取得します。テーブルの後に `ItemNotFound` 段落がない場合は、エラーをスローします。
getParagraphAfterOrNullObject()	テーブルの後の段落を取得します。テーブルの後に段落がない場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getParagraphBefore()	テーブルの前の段落を取得します。テーブルの前に `ItemNotFound` 段落がない場合は、エラーをスローします。
getParagraphBeforeOrNullObject()	テーブルの前の段落を取得します。テーブルの前に段落がない場合、このメソッドはプロパティがに設定されたオブジェクトを`isNullObjecttrue`返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getRange(rangeLocation)	このテーブルを含む範囲、あるいはテーブルの開始または終了の範囲を取得します。
insertContentControl()	テーブルにコンテンツコントロールを挿入します。
insertParagraph(paragraphText, insertLocation)	指定した位置に、段落を挿入します。
insertTable(rowCount, columnCount, insertLocation, values)	指定した数の行と列を含むテーブルを挿入します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
mergeCells(topRow, firstCell, bottomRow, lastCell)	最初のセルと最後のセルで囲まれたセルをマージします。
search(searchText, searchOptions)	テーブルオブジェクトのスコープで、指定した SearchOptions を使用して検索を実行します。検索結果は、範囲オブジェクトのコレクションです。
select(selectionMode)	テーブル、あるいはテーブルの開始位置または終了位置を選択して、Word の UI に移動します。
select(selectionModeString)	テーブル、あるいはテーブルの開始位置または終了位置を選択して、Word の UI に移動します。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
setCellPadding(cellPaddingLocation, cellPadding)	セル内のスペースをポイント単位で設定します。
setCellPadding(cellPaddingLocationString, cellPadding)	セル内のスペースをポイント単位で設定します。
toJSON()	API オブジェクトがに渡されたときにより便利な出力を提供するために、JavaScript `toJSON()` メソッドを `JSON.stringify()`オーバーライドします。 (`JSON.stringify`さらに、渡されるオブジェクトのメソッドを呼び出`toJSON`します)。一方、元のWord。Table オブジェクトは API オブジェクトです。メソッドは、元の`toJSON`オブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (として`Word.Interfaces.TableData`型指定) を返します。
track()	ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、context.trackedObjects.add(thisObject)の短縮形です。このオブジェクトを呼び出しで `.sync` 使用していて、".run" バッチのシーケンシャル実行の外部で使用していて、プロパティを設定するとき、またはオブジェクトのメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
untrack()	前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、context.trackedObjects.remove(thisObject)の短縮形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリ解放が有効になる前にを呼び出す `context.sync()` 必要があります。

プロパティの詳細

alignment

ページ列に対するテーブルの配置を指定します。値には、'Left'、'Centered'、または 'Right' を指定できます。

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`);
  console.log(`- Alignment of the table within the containing page column: ${firstTable.alignment}`);
  console.log(`- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Word.RequestContext

endnotes

テーブル内の文末脚注のコレクションを取得します。

readonly endnotes: Word.NoteItemCollection;

プロパティ値

Word.NoteItemCollection

注釈

[ API セット: WordApi 1.5 ]

fields

テーブル内のフィールドオブジェクトのコレクションを取得します。

readonly fields: Word.FieldCollection;

プロパティ値

Word.FieldCollection

注釈

[ API セット: WordApi 1.4 ]

font

フォントを取得します。これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。

readonly font: Word.Font;

プロパティ値

Word.Font

注釈

[ API セット: WordApi 1.3 ]

footnotes

テーブル内の脚注のコレクションを取得します。

readonly footnotes: Word.NoteItemCollection;

プロパティ値

Word.NoteItemCollection

注釈

[ API セット: WordApi 1.5 ]

headerRowCount

ヘッダー行の数を指定します。

headerRowCount: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.3 ]

horizontalAlignment

テーブル内のすべてのセルの水平方向の配置を指定します。値には、'Left'、'Centered'、'Right'、または 'Justified' を指定できます。

horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`);
  console.log(`- Alignment of the table within the containing page column: ${firstTable.alignment}`);
  console.log(`- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

isUniform

すべてのテーブル行が均一かどうかを示します。

readonly isUniform: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]

nestingLevel

テーブルの入れ子のレベルを取得します。最上位のテーブルのレベルは、レベル 1 です。

readonly nestingLevel: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.3 ]

parentBody

テーブルの親の本文を取得します。

readonly parentBody: Word.Body;

プロパティ値

Word.Body

注釈

[ API セット: WordApi 1.3 ]

parentContentControl

テーブルを含むコンテンツコントロールを取得します。 ItemNotFound親コンテンツコントロールがない場合は、エラーをスローします。

readonly parentContentControl: Word.ContentControl;

プロパティ値

Word.ContentControl

注釈

[ API セット: WordApi 1.3 ]

parentContentControlOrNullObject

テーブルを含むコンテンツコントロールを取得します。親コンテンツコントロールがない場合、このメソッドはプロパティがに設定されたオブジェクトをisNullObjecttrue返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

readonly parentContentControlOrNullObject: Word.ContentControl;

プロパティ値

Word.ContentControl

注釈

[ API セット: WordApi 1.3 ]

parentTable

このテーブルを含むテーブルを取得します。テーブルに ItemNotFound 含まれていない場合は、エラーをスローします。

readonly parentTable: Word.Table;

プロパティ値

Word.Table

注釈

[ API セット: WordApi 1.3 ]

parentTableCell

このテーブルを含むテーブルのセルを取得します。テーブルセルに ItemNotFound 含まれていない場合は、エラーをスローします。

readonly parentTableCell: Word.TableCell;

プロパティ値

Word.TableCell

注釈

[ API セット: WordApi 1.3 ]

parentTableCellOrNullObject

このテーブルを含むテーブルのセルを取得します。テーブルセルに含まれていない場合、このメソッドはプロパティがに設定されたオブジェクトをisNullObjecttrue返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

readonly parentTableCellOrNullObject: Word.TableCell;

プロパティ値

Word.TableCell

注釈

[ API セット: WordApi 1.3 ]

parentTableOrNullObject

このテーブルを含むテーブルを取得します。テーブルに含まれていない場合、このメソッドはプロパティがに設定されたオブジェクトをisNullObjecttrue返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

readonly parentTableOrNullObject: Word.Table;

プロパティ値

Word.Table

注釈

[ API セット: WordApi 1.3 ]

rowCount

表の行数を取得します。

readonly rowCount: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.3 ]

rows

すべてのテーブルの行を取得します。

readonly rows: Word.TableRowCollection;

プロパティ値

Word.TableRowCollection

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets content alignment details about the first row of the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const firstTableRow = firstTable.rows.getFirst();
  firstTableRow.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table's first row:`);
  console.log(`- Horizontal alignment of every cell in the row: ${firstTableRow.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the row: ${firstTableRow.verticalAlignment}`);
});

shadingColor

網かけの色を指定します。色は、"#RRGGBB" 形式で指定するか、色の名前を使用して指定します。

shadingColor: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

style

テーブルのスタイル名を指定します。カスタムスタイルとローカライズされたスタイルの名前には、このプロパティを使用します。ロケール間で移植可能な組み込みスタイルを使用するには、"styleBuiltIn" プロパティを参照してください。

style: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.3 ]

styleBandedColumns

テーブルにバンド列があるかどうかを指定します。

styleBandedColumns: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]

styleBandedRows

テーブルにバンド行があるかどうかを指定します。

styleBandedRows: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]

styleBuiltIn

テーブルの組み込みスタイル名を指定します。ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。カスタムスタイルまたはローカライズされたスタイルの名前を使用するには、"style" プロパティを参照してください。

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

styleFirstColumn

テーブルに特殊なスタイルの最初の列があるかどうかを指定します。

styleFirstColumn: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]

styleLastColumn

テーブルに特殊なスタイルの最後の列があるかどうかを指定します。

styleLastColumn: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]

styleTotalRow

テーブルに特殊なスタイルの合計 (最後) 行があるかどうかを指定します。

styleTotalRow: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]

tables

1 レベル深く入れ子にされた子テーブルを取得します。

readonly tables: Word.TableCollection;

プロパティ値

Word.TableCollection

注釈

[ API セット: WordApi 1.3 ]

values

2D JavaScript 配列として、テーブル内のテキスト値を指定します。

values: string[][];

プロパティ値

string[][]

注釈

[ API セット: WordApi 1.3 ]

verticalAlignment

テーブル内のすべてのセルの垂直方向の配置を指定します。値には、'Top'、'Center'、または 'Bottom' を指定できます。

verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";

プロパティ値

Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`);
  console.log(`- Alignment of the table within the containing page column: ${firstTable.alignment}`);
  console.log(`- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

width

テーブルの幅をポイント単位で指定します。

width: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.3 ]

メソッドの詳細

addColumns(insertLocation, columnCount, values)

最初または最後の既存の列をテンプレートとして使用して、テーブルの最初または最後に列を追加します。これは、統一されたテーブルに適用可能です。指定すると、文字列値は新しく挿入された行に設定されます。

addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void;

パラメーター

insertLocation: start | end | "Start" | "End"

必須です。テーブルの適切な側に対応する 'Start' または 'End' である必要があります。

columnCount: number

必須です。追加する列の数。

values: string[][]

省略可能な 2 次元配列。対応する文字列が配列で指定されている場合、セルに設定されます。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

addRows(insertLocation, rowCount, values)

最初または最後の既存の行をテンプレートとして使用して、テーブルの最初または最後に行を追加します。指定すると、文字列値は新しく挿入された行に設定されます。

addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection;

パラメーター

insertLocation: start | end | "Start" | "End"

必須です。 'Start' または 'End' である必要があります。

rowCount: number

必須です。追加する行数。

values: string[][]

deleteColumns(columnIndex: number, columnCount?: number): void;

パラメーター

columnIndex: number

必須です。削除する最初の列。

columnCount: number

オプション。削除する列の数。既定値は 1 です。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

deleteRows(rowIndex, rowCount)

特定の行を削除します。

deleteRows(rowIndex: number, rowCount?: number): void;

パラメーター

rowIndex: number

必須です。削除する最初の行。

rowCount: number

オプション。削除する行数。既定値は 1 です。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

distributeColumns()

列の幅を揃えます。これは、統一されたテーブルに適用可能です。

distributeColumns(): void;

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

getBorder(borderLocation)

指定した罫線の罫線スタイルを取得します。

getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;

パラメーター

borderLocation: Word.BorderLocation

必須です。罫線の場所。

戻り値

Word.TableBorder

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets border details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const borderLocation = Word.BorderLocation.top;
  const border = firstTable.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

  console.log(`Details about the ${borderLocation} border of the first table:`);
  console.log(`- Color: ${border.color}`);
  console.log(`- Type: ${border.type}`);
  console.log(`- Width: ${border.width} points`);
});

getBorder(borderLocationString)

指定した罫線の罫線スタイルを取得します。

getBorder(borderLocationString: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;

パラメーター

borderLocationString: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"

必須です。罫線の場所。

戻り値

Word.TableBorder

注釈

[ API セット: WordApi 1.3 ]

getCell(rowIndex, cellIndex)

指定された行と列のテーブルセルを取得します。 ItemNotFound指定したテーブルセルが存在しない場合は、エラーをスローします。

getCell(rowIndex: number, cellIndex: number): Word.TableCell;

パラメーター

rowIndex: number

必須です。行のインデックスです。

cellIndex: number

必須です。行のセルのインデックス。

戻り値

Word.TableCell

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/table-cell-access.yaml

// Gets the content of the first cell in the first table.
await Word.run(async (context) => {
  const firstCell = context.document.body.tables.getFirst().getCell(0, 0).body;
  firstCell.load("text");

  await context.sync();
  console.log("First cell's text is: " + firstCell.text);
});

getCellOrNullObject(rowIndex, cellIndex)

指定された行と列のテーブルセルを取得します。指定したテーブルセルが存在しない場合、このメソッドはプロパティがに設定されたオブジェクトをisNullObjecttrue返します。詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell;

パラメーター

rowIndex: number

必須です。行のインデックスです。

cellIndex: number

必須です。行のセルのインデックス。

戻り値

Word.TableCell

注釈

[ API セット: WordApi 1.3 ]

getCellPadding(cellPaddingLocation)

セル内のスペースをポイント単位で取得します。

getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;

パラメーター

cellPaddingLocation: Word.CellPaddingLocation

必須です。セルのパディングの場所は、'Top'、'Left'、'Bottom'、または 'Right' である必要があります。

戻り値

OfficeExtension.ClientResult<number>

注釈

[ API セット: WordApi 1.3 ]

例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets cell padding details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const cellPaddingLocation = Word.CellPaddingLocation.right;
  const cellPadding = firstTable.getCellPadding(cellPaddingLocation);
  await context.sync();

  console.log(
    `Cell padding details about the ${cellPaddingLocation} border of the first table: ${cellPadding.value} points`
  );
});

getCellPadding(cellPaddingLocationString)

セル内のスペースをポイント単位で取得します。

getCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;

パラメーター

cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range;

パラメーター

rangeLocation: whole | start | end | after | "Whole" | "Start" | "End" | "After"

オプション。範囲の場所は、'Whole'、'Start'、'End'、または 'After' である必要があります。

戻り値

Word.Range

注釈

[ API セット: WordApi 1.3 ]

insertContentControl()

テーブルにコンテンツコントロールを挿入します。

insertContentControl(): Word.ContentControl;

戻り値

Word.ContentControl

注釈

[ API セット: WordApi 1.3 ]

insertParagraph(paragraphText, insertLocation)

指定した位置に、段落を挿入します。

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

パラメーター

paragraphText: string

必須です。挿入する段落テキスト。

insertLocation: before | after | "Before" | "After"

必須です。値は 'Before' または 'After' である必要があります。

戻り値

Word.Paragraph

注釈

[ API セット: WordApi 1.3 ]

insertTable(rowCount, columnCount, insertLocation, values)

指定した数の行と列を含むテーブルを挿入します。

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;

パラメーター

rowCount: number

必須です。表の行数。

columnCount: number

必須です。表の列数。

insertLocation: before | after | "Before" | "After"

必須です。値は 'Before' または 'After' である必要があります。

values: string[][]

省略可能な 2 次元配列。対応する文字列が配列で指定されている場合、セルに設定されます。

戻り値

Word.Table

注釈

[ API セット: WordApi 1.3 ]

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.TableLoadOptions): Word.Table;

パラメーター

options: Word.Interfaces.TableLoadOptions

読み込むオブジェクトのプロパティのオプションを提供します。

戻り値

Word.Table

load(propertyNames)

load(propertyNames?: string | string[]): Word.Table;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。

戻り値

Word.Table

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Table;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は、読み込むプロパティを指定するコンマ区切り文字列で propertyNamesAndPaths.expand 、読み込むナビゲーションプロパティを指定するコンマ区切りの文字列です。

戻り値

Word.Table

mergeCells(topRow, firstCell, bottomRow, lastCell)

最初のセルと最後のセルで囲まれたセルをマージします。

mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell;

パラメーター

topRow: number

必須です。最初のセルの行

firstCell: number

必須です。行の最初のセルのインデックス

bottomRow: number

必須です。最後のセルの行

lastCell: number

必須です。行の最後のセルのインデックス

戻り値

Word.TableCell

注釈

[ API セット: WordApi 1.4 ]

search(searchText, searchOptions)

テーブルオブジェクトのスコープで、指定した SearchOptions を使用して検索を実行します。検索結果は、範囲オブジェクトのコレクションです。

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

パラメーター

searchText: string

必須です。検索テキスト。

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

オプション。検索のオプション。

戻り値

Word.RangeCollection

注釈

[ API セット: WordApi 1.3 ]

select(selectionMode)

テーブル、あるいはテーブルの開始位置または終了位置を選択して、Word の UI に移動します。

select(selectionMode?: Word.SelectionMode): void;

パラメーター

selectionMode: Word.SelectionMode

オプション。選択モードは、'Select'、'Start'、または 'End' である必要があります。 'Select' が既定値です。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

select(selectionModeString)

テーブル、あるいはテーブルの開始位置または終了位置を選択して、Word の UI に移動します。

select(selectionModeString?: "Select" | "Start" | "End"): void;

パラメーター

selectionModeString: "Select" | "Start" | "End"

オプション。選択モードは、'Select'、'Start'、または 'End' である必要があります。 'Select' が既定値です。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties: Word.Interfaces.TableUpdateData

メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

戻り値

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.Table): void;

パラメーター

properties: Word.Table

戻り値

void

setCellPadding(cellPaddingLocation, cellPadding)

セル内のスペースをポイント単位で設定します。

setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;

パラメーター

cellPaddingLocation: Word.CellPaddingLocation

必須です。セルのパディングの場所は、'Top'、'Left'、'Bottom'、または 'Right' である必要があります。

cellPadding: number

必須です。セルのパディング。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

setCellPadding(cellPaddingLocationString, cellPadding)

セル内のスペースをポイント単位で設定します。

setCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;

パラメーター

cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"

必須です。セルのパディングの場所は、'Top'、'Left'、'Bottom'、または 'Right' である必要があります。

cellPadding: number

必須です。セルのパディング。

戻り値

void

注釈

[ API セット: WordApi 1.3 ]

toJSON()

API オブジェクトがに渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを JSON.stringify()オーバーライドします。 (JSON.stringifyさらに、渡されるオブジェクトのメソッドを呼び出toJSONします)。一方、元のWord。Table オブジェクトは API オブジェクトです。メソッドは、元のtoJSONオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト (としてWord.Interfaces.TableData型指定) を返します。

toJSON(): Word.Interfaces.TableData;

戻り値

Word.Interfaces.TableData

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、context.trackedObjects.add(thisObject)の短縮形です。このオブジェクトを呼び出しで .sync 使用していて、".run" バッチのシーケンシャル実行の外部で使用していて、プロパティを設定するとき、またはオブジェクトのメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.Table;

戻り値

Word.Table

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、context.trackedObjects.remove(thisObject)の短縮形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリ解放が有効になる前にを呼び出す context.sync() 必要があります。

untrack(): Word.Table;

戻り値

Word.Table