全部产品

表格

表格对象

文档中所有表格的集合。

语法:

表达式.ActiveDocument.Tables

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;
}

插入表格

语法:

表达式.ActiveDocument.Tables.Add({ Range, NumRows, NumColumns, DefaultTableBehavior, AutoFitBehavior })

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

Range

Object

位置信息。表达式.ActiveDocument.Selection.Range

NumRows

Number

新建表格的行数

NumColumns

Number

新建表格的列数

DefaultTableBehavior

Number

单元格是否自动调整大小以适应单元格的内容,可参考Enum.WdDefaultTableBehavior

AutoFitBehavior

Number

设置 Word 调整表格的大小的自动调整规则,可参考Enum.WdAutoFitBehavior

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 插入表格
  await tables.Add(
    app.ActiveDocument.Selection.Range, // 位置信息
    3, // 新增表格的行数
    3, // 新增表格的列数
    1, // 启用自动调整功能
    1, // 根据表格中包含的内容自动调整表格的大小
  );
}

表格总个数

获取页面中总表格数量。

语法:

表达式.ActiveDocument.Tables.Count

表达式:文档类型应用对象

返回值:

返回 Number 表示页面中总表格数量

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取页面中总表格数量
  const count = await tables.Count;
  console.log(count);
}

单个表格

单个表格对象

获取单个表格。

语法:

表达式.ActiveDocument.Tables.Item(Index)

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

Index

Number

第 Index 个表格

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);
}

删除表格

语法:

表达式.ActiveDocument.Tables.Item(Index).Delete()

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 删除第 1 个表格
  await tableOne.Delete();
}

表格区域

表格的范围。

语法:

表达式.ActiveDocument.Tables.Item(Index).Range

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取第 1 个表格的范围
  const range = await tableOne.Range;
}

列对象

获取表格列。

语法:

表达式.ActiveDocument.Tables.Item(Index).Columns

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取第 1 个表格的所有列
  const columns = tableOne.Columns;
}

总列数

获取表格总列数。

语法:

表达式.ActiveDocument.Tables.Item(Index).Columns.Count

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有列
  const columns = await tableOne.Columns;

  // 获取表格总列数
  const count = await columns.Count;
  console.log(count);
}

插入列

插入表格列。

语法:

表达式.ActiveDocument.Tables.Item(Index).Columns.Add(BeforeColumn)

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

BeforeColumn

String

代表将会直接显示在新列右侧的 Column 对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有列
  const columns = await tableOne.Columns;

  // 插入列
  await columns.Add(1);
}

单列

单列对象

获取表格某一列。

语法:

表达式.ActiveDocument.Tables.Item(Index).Columns.Item(Index)

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

Index

Number

第 Index 列

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有列
  const columns = await tableOne.Columns;

  // 获取表格第 1 列
  const columnOne = await columns.Item(1);
}

删除列

删除表格列。

语法:

表达式.ActiveDocument.Tables.Item(Index).Columns.Item(Index).Delete()

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有列
  const columns = await tableOne.Columns;

  // 获取表格第 1 列
  const columnOne = await columns.Item(1);

  // 删除第 1 列
  columnOne.Delete();
}

列宽

设置表格列的宽度。

语法:

表达式.ActiveDocument.Tables.Item(Index).Columns.Item(Index).SetWidth()

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

ColumnWidth

Number

指定列的宽度,以磅为单位

RulerStyle

Enum

控制 Word(文字)调整单元格宽度的方式,可参照Enum.WdRulerStyle

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有列
  const columns = await tableOne.Columns;

  // 获取表格第 1 列
  const columnOne = await columns.Item(1);

  // 调整第 1 列宽度
  columnOne.SetWidth(50);
}

列区域

表格列的范围。

语法:

表达式.ActiveDocument.Tables.Item(Index).Columns.Item(Index).Range

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有列
  const rows = await tableOne.Columns;

  // 获取表格第 1 列
  const rowOne = await rows.Item(1);

  // 获取第 1 列的 Range 对象
  const range = rowOne.Range;
}

行对象

获取表格行。

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取第 1 个表格的所有行
  const columns = tableOne.Rows;
}

总行数

获取表格总行数。

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows.Count

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有行
  const columns = await tableOne.Rows;

  // 获取表格总行数
  const count = await columns.Count;
  console.log(count);
}

插入行

插入表格行。

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows.Add(BeforeRow)

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

BeforeRow

String

代表将会直接显示在新行右侧的 Rows 对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有行
  const columns = await tableOne.Rows;

  // 插入行
  await columns.Add(1);
}

单行

单行对象

获取表格某一行。

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index)

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

Index

Number

第 Index 行

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有行
  const rows = await tableOne.Rows;

  // 获取表格第 1 行
  const rowOne = await rows.Item(1);
}

删除行

删除表格行。

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Delete()

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有行
  const rows = await tableOne.Rows;

  // 获取表格第 1 行
  const rowOne = await rows.Item(1);

  // 删除第 1 行
  rowOne.Delete();
}

行高

设置表格行的宽度。

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).SetHeight()

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

RowWidth

Number

指定行的宽度,以磅为单位

HeightRule

Enum

用于确定指定行的高度的规则,可参照Enum.WdRowHeightRule

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有行
  const rows = await tableOne.Rows;

  // 获取表格第 1 行
  const rowOne = await rows.Item(1);

  // 调整第 1 行高度
  rowOne.SetHeight(50);
}

行区域

表格行的范围。

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Range

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取所有表格
  const tables = await app.ActiveDocument.Tables;

  // 获取第 1 个表格
  const tableOne = await tables.Item(1);

  // 获取表格所有行
  const rows = await tableOne.Rows;

  // 获取表格第 1 行
  const rowOne = await rows.Item(1);

  // 获取第 1 行的 Range 对象
  const range = rowOne.Range;
}

单元格

单元格对象

表格列、表格行、选定内容或区域中的 Cell 对象的集合。

语法:

  • 表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells

  • 表达式.ActiveDocument.Tables.Item(Index).Columns.Item(Index).Cells

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取第 1 个表格
  const tableOne = await app.ActiveDocument.Tables.Item(1);

  // 获取表格第 1 行的第 1 个单元格的文本
  const rowText = await tableOne.Rows.Item(1).Cells.Item(1).Range.Text;
  console.log(rowText);

  // 获取表格第 2 列的第 2 个单元格的文本
  const columnText = await tableOne.Rows.Item(2).Cells.Item(2).Range.Text;
  console.log(columnText);
}

单个单元格

单个单元格对象

某一个单元格。

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index)

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

Index

String

第 Index 个单元格

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取第 1 个表格
  const tableOne = await app.ActiveDocument.Tables.Item(1);

  // 获取表格第 1 行的第 1 个单元格
  const rowText = await tableOne.Rows.Item(1).Cells.Item(1);
}

删除单元格

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Delete()

表达式:文档类型应用对象

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取第 1 个表格
  const tableOne = await app.ActiveDocument.Tables.Item(1);

  // 获取表格第 1 行的第 1 个单元格
  const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
  
  // 删除该单元格所在的行
  await cellOne.Delete();
}

宽度设置

设置表格行的宽度。

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).SetWidth()

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

RowWidth

Number

指定行的宽度,以磅为单位

HeightRule

Enum

用于确定指定行的高度的规则,可参照Enum.WdRowHeightRule

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // 获取第 1 个表格
  const tableOne = await app.ActiveDocument.Tables.Item(1);

  // 获取表格第 1 行的第 1 个单元格
  const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
  
  // 调整该单元格所在的宽度
  await cellOne.SetWidth(50);
}

高度设置

设置表格列的高度。

语法:

表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).SetHeight()

表达式:文档类型应用对象

参数:

属性

数据类型

必填

说明

RowWidth

Number

指定行的宽度,以磅为单位

HeightRule

Enum

用于确定指定行的高度的规则,可参照Enum.WdRowHeightRule

示例:

async function example() {
  await instance.ready();

  const app = instance.Application;

  // 获取第 1 个表格
  const tableOne = await app.ActiveDocument.Tables.Item(1);

  // 获取表格第 1 行的第 1 个单元格
  const cellOne = await tableOne.Rows.Item(1).Cells.Item(1);
  
  // 调整该单元格所在的高度
  await cellOne.SetHeight(50);
}