Columns

Columns

JSSDK: 1.3.0、zOffice V6 支持

指定表格列的集合。

属性

count

指定表格列数量。

语法

Columns.count

返回值

Promise<number>

示例

async function example() {
  const table = await Application.ActiveDocument.Tables.item(1);
  const count = await table.Columns.count;
}

方法

add

插入列。

语法

Columns.add(index, cnt, isBefore)

参数

属性	数据类型	必填	说明
index	number	是	列序号（从1开始）
cnt	number	是	插入数量 (从1开始, 最大不超过50)
isBefore	boolean	是	布尔值 (true: 在左侧插入列；false：在右侧插入列)

返回值

Promise<boolean> 是否插入成功

示例

async function example(index, cnt, isBefore) {
  const table = await Application.ActiveDocument.Tables.item(1);
  const columns = await table.Columns;
  const success = await columns.add(index, cnt, isBefore);
}

deleteColumns

删除指定列。

语法

Columns.deleteColumns(index, cnt, isBefore)

参数

属性	数据类型	必填	说明
index	number	是	列序号（从1开始）
cnt	number	否	删除数量 (默认为1)
isBefore	boolean	否	布尔值 (true: 往左侧删除列；false：往右侧删除列，默认为false)

返回值

Promise<boolean>

示例

async function example(index, cnt, isBefore) {
  const table = await Application.ActiveDocument.Tables.item(1);
  const success = await table.Columns.deleteColumns(index, cnt, isBefore);
}

item

根据参数获取表格列。

语法

Columns.item(index)

参数

属性	数据类型	必填	说明
index	number	是	列序号（从1开始）

返回值

Promise<Word.Column>

示例

async function example(index, cnt, isBefore) {
  const table = await Application.ActiveDocument.Tables.item(1);
  const column = await table.Columns.item(1);
}