文档

Table

更新时间:

本文介绍与文字文档Table相关的API。

Tables

ActiveDocument.Tables

获取文档中的所有表格。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取文档中的所有表格
      const tables = await app.ActiveDocument.Tables;
    }

方法

ActiveDocument.Tables.Add()

通过Add()方法,您可以插入表格。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

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

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    Range

    Object

    位置信息。

    NumRows

    Number

    新建表格的行数。

    NumColumns

    Number

    新建表格的列数。

    DefaultTableBehavior

    Enum

    是否根据内容自动调整单元格大小。更多信息,请参见WdDefaultTableBehavior

    AutoFitBehavior

    Enum

    设置自动调整单元格大小的规则。更多信息,请参见WdAutoFitBehavior

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取文档中的所有表格
      const tables = await app.ActiveDocument.Tables;
    
      //插入表格
      await tables.Add(
        app.ActiveDocument.ActiveWindow.Selection.Range, //位置信息
        3, //新增表格的行数
        3, //新增表格的列数
        1, //启用自动调整功能
        1, //根据表格中包含的内容自动调整表格的大小
      );
    
    }

属性

ActiveDocument.Tables.Count

通过Count属性,您可以获取文档中表格的总数量。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.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);
    }

Table

ActiveDocument.Tables.Item()

获取单个表格对象。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.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()

通过Delete()方法,您可以删除单个表格。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.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();
    }

Cells

ActiveDocument.ActiveWindow.Selection.Cells

获取选定内容中的所有单元格。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

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

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

      或者表达式.ActiveDocument.ActiveWindow.Selection.Cells

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

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取第1个表格
      const tableOne = await app.ActiveDocument.Tables.Item(1);
    
      //获取表格第1行的所有单元格
      const rowText = await tableOne.Rows.Item(1).Cells;
    
      //获取表格第2列的所有单元格
      const columnText = await tableOne.Columns.Item(2).Cells;
    }

Cell

ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item()

获取单个单元格对象。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.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()

通过Delete()方法,您可以删除指定单元格。

  • 语法

    表达式.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).SetHeight()

通过SetHeight()方法,您可以设置指定单元格行的高度。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).SetHeight({ RowHeight, HeightRule })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    RowHeight

    Number

    指定单元格行的高度,以磅为单位。

    HeightRule

    Enum

    用于确定指定行高度的规则。更多信息,请参见WdRowHeightRule

ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).SetWidth()

通过SetWidth()方法,您可以设置指定单元格列的宽度。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).SetWidth({ ColumnWidth, RulerStyle })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    ColumnWidth

    Number

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

    RulerStyle

    Enum

    控制文字调整单元格宽度的方式。更多信息,请参见WdRulerStyle

属性

ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.Item(Index).Range

通过Range属性,您可以获取指定单元格中包含文档部分的Range对象。

  • 语法

    表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).Cells.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行的第1个单元格
      const cell = await tableOne.Rows.Item(1).Cells.Item(1);
    
      //获取该单元格中包含文档部分的Range对象
      const range = await cell.Range;
    }

Columns

ActiveDocument.Tables.Item(Index).Columns

获取表格所有列。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.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);
    
      //获取该表格的所有列
      const columns = tableOne.Columns;
    }

方法

ActiveDocument.Tables.Item(Index).Columns.Add()

通过Add()方法,您可以插入表格列。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

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

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    BeforeColumn

    Number

    表示将会直接显示在新列右侧的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.Count

通过Count属性,您可以获取表格总列数。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.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);
    }

Column

ActiveDocument.Tables.Item(Index).Columns.Item()

获取表格某一列。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.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()

通过Delete()方法,您可以删除指定表格列。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

    表达式.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()

通过SetWidth()方法,您可以设置指定表格列的宽度。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 方法

    表达式.ActiveDocument.Tables.Item(Index).Columns.Item(Index).SetWidth({ ColumnWidth, RulerStyle })

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    ColumnWidth

    Number

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

    RulerStyle

    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).Cells

通过Cells属性,您可以获取表格指定列中的所有单元格。

重要

JS-SDK V1.1.10及以上版本支持此功能。

  • 语法

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

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

  • 示例

    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列的所有单元格
      const cells = columnOne.Cells;
    }

Rows

ActiveDocument.Tables.Item(Index).Rows

获取指定表格的所有行。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.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 rows = tableOne.Rows;
    }

方法

ActiveDocument.Tables.Item(Index).Rows.Add()

通过Add()方法,您可以在指定位置插入行。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

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

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

  • 参数

    属性

    数据类型

    是否必填

    描述

    BeforeRow

    Number

    表示将会直接显示在新行下方的行对象。

  • 示例

    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;
    
      //插入行
      await rows.Add(1);
    }

属性

ActiveDocument.Tables.Item(Index).Rows.Count

通过Count属性,您可以获取表格总行数。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.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 rows = await tableOne.Rows;
    
      //获取表格总行数
      const count = await rows.Count;
      console.log(count);
    }

Row

ActiveDocument.Tables.Item(Index).Rows.Item()

获取表格的某一行。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.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()

通过Delete()方法,您可以删除表格某一行。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.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()

通过SetHeight()方法,您可以设置表格某一行的高度。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.ActiveDocument.Tables.Item(Index).Rows.Item(Index).SetHeight({ RowHeight, HeightRule })

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

  • 参数

    属性

    数据类型

    是否必填

    说明

    RowHeight

    Number

    指定行的高度,以磅为单位。

    HeightRule

    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).Cells

通过Cells属性,您可以获取表格某一行的所有单元格。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

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

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

  • 示例

    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行的所有单元格
      const cells = rowOne.Cells;
    }

ActiveDocument.Tables.Item(Index).Rows.Item(Index).Range

通过Range属性,您可以获取表格某一行中包含文档部分的Range对象。

重要
  • JS-SDK V1.1.10及以上版本支持此功能。

  • 仅PC端支持此功能。

  • 语法

    表达式.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;
    }