Excel.TableColumn class

代表表格中的一列。

扩展

注解

[ API 集:ExcelApi 1.1 ]

属性

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

filter

检索应用于列的筛选器。

id

返回标识表内的列的唯一键。

index

返回表的列集合内列的索引编号。 从零开始编制索引。

name

指定表列的名称。

values

表示指定区域的原始值。 返回的数据可以是字符串、数字或布尔值。 包含错误的单元格将返回错误字符串。 如果返回的值以加号 (“+”) 、减 (“-”) 或等号 (“=”) 开头,Excel 会将此值解释为公式。

valuesAsJson

此表列中单元格中的值的 JSON 表示形式。 与 不同 TableColumn.valuesTableColumn.valuesAsJson 支持可在单元格中的所有数据类型。 示例包括格式化的数字值和 Web 图像,以及标准布尔值、数字值和字符串值。 从此 API 返回的数据始终与 en-US 区域设置一致。 若要检索用户的显示区域设置中的数据,请使用 TableColumn.valuesAsJsonLocal

valuesAsJsonLocal

此表列中单元格中的值的 JSON 表示形式。 与 不同 TableColumn.valuesTableColumn.valuesAsJsonLocal 支持可在单元格中的所有数据类型。 示例包括格式化的数字值和 Web 图像,以及标准布尔值、数字值和字符串值。 从此 API 返回的数据始终与用户的显示区域设置保持一致。 若要检索独立于区域设置的数据,请使用 TableColumn.valuesAsJson

方法

delete()

从表中删除列。

getDataBodyRange()

获取与列的数据体相关的 range 对象。

getHeaderRowRange()

获取与列的标头行相关的 range 对象。

getRange()

获取与整个列相关的 range 对象。

getTotalRowRange()

获取与列的总计行相关的 range 对象。

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,反过来,调用toJSON传递给它的 对象的 方法。) 而原始 Excel.TableColumn 对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.TableColumnData) ,其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

filter

检索应用于列的筛选器。

readonly filter: Excel.Filter;

属性值

注解

[ API 集:ExcelApi 1.2 ]

id

返回标识表内的列的唯一键。

readonly id: number;

属性值

number

注解

[ API 集:ExcelApi 1.1 ]

index

返回表的列集合内列的索引编号。 从零开始编制索引。

readonly index: number;

属性值

number

注解

[ API 集:ExcelApi 1.1 ]

name

指定表列的名称。

name: string;

属性值

string

注解

[ API 集:ExcelApi 1.1 用于获取名称;1.4 用于设置名称。 ]

values

表示指定区域的原始值。 返回的数据可以是字符串、数字或布尔值。 包含错误的单元格将返回错误字符串。 如果返回的值以加号 (“+”) 、减 (“-”) 或等号 (“=”) 开头,Excel 会将此值解释为公式。

values: any[][];

属性值

any[][]

注解

[ API 集:ExcelApi 1.1 ]

valuesAsJson

此表列中单元格中的值的 JSON 表示形式。 与 不同 TableColumn.valuesTableColumn.valuesAsJson 支持可在单元格中的所有数据类型。 示例包括格式化的数字值和 Web 图像,以及标准布尔值、数字值和字符串值。 从此 API 返回的数据始终与 en-US 区域设置一致。 若要检索用户的显示区域设置中的数据,请使用 TableColumn.valuesAsJsonLocal

valuesAsJson: CellValue[][];

属性值

注解

[ API 集:ExcelApi 1.16 ]

valuesAsJsonLocal

此表列中单元格中的值的 JSON 表示形式。 与 不同 TableColumn.valuesTableColumn.valuesAsJsonLocal 支持可在单元格中的所有数据类型。 示例包括格式化的数字值和 Web 图像,以及标准布尔值、数字值和字符串值。 从此 API 返回的数据始终与用户的显示区域设置保持一致。 若要检索独立于区域设置的数据,请使用 TableColumn.valuesAsJson

valuesAsJsonLocal: CellValue[][];

属性值

注解

[ API 集:ExcelApi 1.16 ]

方法详细信息

delete()

从表中删除列。

delete(): void;

返回

void

注解

[ API 集:ExcelApi 1.1 ]

示例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItemAt(2);
    column.delete();
    await context.sync(); 
});

getDataBodyRange()

获取与列的数据体相关的 range 对象。

getDataBodyRange(): Excel.Range;

返回

注解

[ API 集:ExcelApi 1.1 ]

示例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const dataBodyRange = column.getDataBodyRange();
    dataBodyRange.load('address');
    await context.sync();
    
    console.log(dataBodyRange.address);
});

getHeaderRowRange()

获取与列的标头行相关的 range 对象。

getHeaderRowRange(): Excel.Range;

返回

注解

[ API 集:ExcelApi 1.1 ]

示例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const headerRowRange = columns.getHeaderRowRange();
    headerRowRange.load('address');
    await context.sync();
    
    console.log(headerRowRange.address);
});

getRange()

获取与整个列相关的 range 对象。

getRange(): Excel.Range;

返回

注解

[ API 集:ExcelApi 1.1 ]

示例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const columnRange = columns.getRange();
    columnRange.load('address');
    await context.sync();
    
    console.log(columnRange.address);
});

getTotalRowRange()

获取与列的总计行相关的 range 对象。

getTotalRowRange(): Excel.Range;

返回

注解

[ API 集:ExcelApi 1.1 ]

示例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const columns = context.workbook.tables.getItem(tableName).columns.getItemAt(0);
    const totalRowRange = columns.getTotalRowRange();
    totalRowRange.load('address');
    await context.sync();
    
    console.log(totalRowRange.address);
});

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(options?: Excel.Interfaces.TableColumnLoadOptions): Excel.TableColumn;

参数

options
Excel.Interfaces.TableColumnLoadOptions

提供要加载对象的属性的选项。

返回

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames?: string | string[]): Excel.TableColumn;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

示例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const column = context.workbook.tables.getItem(tableName).columns.getItem(0);
    column.load('index');
    await context.sync();
    
    console.log(column.index);
});

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TableColumn;

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。

返回

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

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

参数

properties
Excel.Interfaces.TableColumnUpdateData

一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

set(properties: Excel.TableColumn): void;

参数

properties
Excel.TableColumn

返回

void

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,反过来,调用toJSON传递给它的 对象的 方法。) 而原始 Excel.TableColumn 对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Excel.Interfaces.TableColumnData) ,其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Excel.Interfaces.TableColumnData;

返回