Word.Table class

ページ列に対するテーブルの配置を指定します。 値には、 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: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

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

テーブルの列を表す TableColumnCollection オブジェクトを返します。

readonly columns: Word.TableColumnCollection;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

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

context: RequestContext;

プロパティ値

テーブルの説明を指定します。

description: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

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

readonly endnotes: Word.NoteItemCollection;

プロパティ値

注釈

API セット: WordAPI 1.5

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

readonly fields: Word.FieldCollection;

プロパティ値

注釈

API セット: WordApi 1.4

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

readonly font: Word.Font;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly footnotes: Word.NoteItemCollection;

プロパティ値

注釈

API セット: WordAPI 1.5

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

headerRowCount: number;

プロパティ値

注釈

API セット: WordApi 1.3

テーブル内のすべてのセルの水平方向の配置を指定します。 値には、 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: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

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

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

readonly isUniform: boolean;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly nestingLevel: number;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly parentBody: Word.Body;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly parentContentControl: Word.ContentControl;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly parentContentControlOrNullObject: Word.ContentControl;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly parentTable: Word.Table;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly parentTableCell: Word.TableCell;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly parentTableCellOrNullObject: Word.TableCell;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly parentTableOrNullObject: Word.Table;

プロパティ値

注釈

API セット: WordApi 1.3

表の行数を取得します。

readonly rowCount: number;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly rows: 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: Word.Table = context.document.body.tables.getFirst();
  const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
  firstTableRow.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

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

テーブルの網掛けを表す ShadingUniversal オブジェクトを返します。

readonly shading: Word.ShadingUniversal;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

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

shadingColor: string;

プロパティ値

注釈

API セット: WordApi 1.3

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

style: string;

プロパティ値

注釈

API セット: WordApi 1.3

テーブルに縞模様の列があるかどうかを指定します。

styleBandedColumns: boolean;

プロパティ値

注釈

API セット: WordApi 1.3

テーブルに縞模様の行があるかを指定します。

styleBandedRows: boolean;

プロパティ値

注釈

API セット: WordApi 1.3

テーブルの組み込みスタイル名を指定します。 ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。 カスタム スタイルまたはローカライズされたスタイルの名前を使用するには、"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: boolean;

プロパティ値

注釈

API セット: WordApi 1.3

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

styleLastColumn: boolean;

プロパティ値

注釈

API セット: WordApi 1.3

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

styleTotalRow: boolean;

プロパティ値

注釈

API セット: WordApi 1.3

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

readonly tables: Word.TableCollection;

プロパティ値

注釈

API セット: WordApi 1.3

テーブルのタイトルを指定します。

title: string;

プロパティ値

注釈

API セット: WordApiDesktop 1.4

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

values: string[][];

プロパティ値

注釈

API セット: WordApi 1.3

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

verticalAlignment: 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: Word.Table = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

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

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

width: number;

プロパティ値

注釈

API セット: WordApi 1.3

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

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

パラメーター

返品

注釈

API セット: WordApi 1.3

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

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

パラメーター

返品

注釈

API セット: WordApi 1.3

指定した書式を適用しますが、ユーザーが直接適用した形式は維持します。

applyStyleDirectFormatting(styleName: string): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

自動調整機能を使用する場合に表のサイズ変更が行われる方法を決定します。

autoFitBehavior(behavior: Word.AutoFitBehavior): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

自動調整機能を使用する場合に表のサイズ変更が行われる方法を決定します。

autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

テーブルの列をウィンドウの幅に合わせて自動調整します。

autoFitWindow(): void;

返品

注釈

API セット: WordApi 1.3

あらかじめ定義されている書式を表に設定します。

autoFormat(options?: Word.TableAutoFormatOptions): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

テーブルの内容をクリアします。

clear(): void;

返品

注釈

API セット: WordApi 1.3

表を文字列に変換します。

convertToText(options?: Word.TableConvertToTextOptions): Word.Range;

パラメーター

返品

変換されたテキストを表す Range オブジェクト。

注釈

API セット: WordApiDesktop 1.4

テーブル全体を削除します。

delete(): void;

返品

注釈

API セット: WordApi 1.3

特定の列を削除します。 これは、統一されたテーブルに適用可能です。

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

パラメーター

返品

注釈

API セット: WordApi 1.3

特定の行を削除します。

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

パラメーター

返品

注釈

API セット: WordApi 1.3

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

distributeColumns(): void;

返品

注釈

API セット: WordApi 1.3

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

getBorder(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: Word.Table = context.document.body.tables.getFirst();
  const borderLocation = Word.BorderLocation.top;
  const border: Word.TableBorder = firstTable.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

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

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

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

パラメーター

返品

注釈

API セット: WordApi 1.3

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

getCell(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: Word.Body = context.document.body.tables.getFirst().getCell(0, 0).body;
  firstCell.load("text");

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

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

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

パラメーター

返品

注釈

API セット: WordApi 1.3

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

getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): 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: Word.Table = 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(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;

パラメーター

返品

注釈

API セット: WordApi 1.3

次のテーブルを取得します。 このテーブルが最後のテーブルである場合は、 ItemNotFound エラーをスローします。

getNext(): Word.Table;

返品

注釈

API セット: WordApi 1.3

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

getNextOrNullObject(): Word.Table;

返品

注釈

API セット: WordApi 1.3

テーブルの後の段落を取得します。 表の後に段落がない場合は、 ItemNotFound エラーをスローします。

getParagraphAfter(): Word.Paragraph;

返品

注釈

API セット: WordApi 1.3

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

getParagraphAfterOrNullObject(): Word.Paragraph;

返品

注釈

API セット: WordApi 1.3

テーブルの前の段落を取得します。 表の前に段落がない場合は、 ItemNotFound エラーをスローします。

getParagraphBefore(): Word.Paragraph;

返品

注釈

API セット: WordApi 1.3

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

getParagraphBeforeOrNullObject(): Word.Paragraph;

返品

注釈

API セット: WordApi 1.3

このテーブルを含む範囲、あるいはテーブルの開始または終了の範囲を取得します。

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

パラメーター

返品

注釈

API セット: WordApi 1.3

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

insertContentControl(): Word.ContentControl;

返品

注釈

API セット: WordApi 1.3

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

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

パラメーター

返品

注釈

API セット: WordApi 1.3

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

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

パラメーター

返品

注釈

API セット: WordApi 1.3

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

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

パラメーター

返品

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

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

パラメーター

返品

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

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

パラメーター

返品

最初と最後のセルで囲まれたセルを結合します。

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

パラメーター

返品

注釈

API セット: WordApi 1.4

autoFormat メソッドが呼び出されたときに設定された定義済みテーブル形式の特性を持つテーブルをUpdatesします。 既定の定義済み形式は TableFormatType.none です。

reapplyAutoFormat(): void;

返品

注釈

API セット: WordApiDesktop 1.4

Table オブジェクトのスコープに対して、指定された検索オプションを使用して検索を実行します。 検索結果は、 Range オブジェクトのコレクションです。

search(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

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

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

パラメーター

返品

注釈

API セット: WordApi 1.3

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

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

パラメーター

返品

注釈

API セット: WordApi 1.3

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

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

パラメーター

返品

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

set(properties: Word.Table): void;

パラメーター

返品

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

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

パラメーター

返品

注釈

API セット: WordApi 1.3

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

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

パラメーター

返品

注釈

API セット: WordApi 1.3

指定した表を並べ替えます。

sort(options?: Word.TableSortOptions): void;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

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

toJSON(): Word.Interfaces.TableData;

返品

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

track(): Word.Table;

返品

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

untrack(): Word.Table;

返品