Excel.Table class

包:

excel

表示 Excel 表格。 若要了解有关表对象模型的详细信息，请阅读 使用 Excel JavaScript API 处理表。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.1 ]

属性

columns	表示表中所有列的集合。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
id	返回用于唯一标识指定工作簿中表的值。 即使表被重命名，标识符的值仍保持不变。
name	表的名称。 表集名称必须遵循 重命名 Excel 表格一 文中指定的准则。
rows	表示表中所有行的集合。
showHeaders	指定标题行是否可见。 该值可以设置为显示或删除标头行。
showTotals	指定总行是否可见。 该值可以设置为显示或删除总计行。
style	表示表格样式的常量值。 可能的值为：“TableStyleLight1”到“TableStyleLight21”、“TableStyleMedium1”到“TableStyleMedium28”、“TableStyleDark1”到“TableStyleDark11”。 还可以指定工作簿中显示的用户定义的自定义样式。

方法

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.Table对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.TableData) ，其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

columns

表示表中所有列的集合。

readonly columns: Excel.TableColumnCollection;

属性值

Excel.TableColumnCollection

注解

[ API 集：ExcelApi 1.1 ]

context

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

context: RequestContext;

属性值

Excel.RequestContext

id

返回用于唯一标识指定工作簿中表的值。 即使表被重命名，标识符的值仍保持不变。

readonly id: string;

属性值

string

注解

[ API 集：ExcelApi 1.1 ]

name

表的名称。

表集名称必须遵循 重命名 Excel 表格一 文中指定的准则。

name: string;

属性值

string

注解

[ API 集：ExcelApi 1.1 ]

rows

表示表中所有行的集合。

readonly rows: Excel.TableRowCollection;

属性值

Excel.TableRowCollection

注解

[ API 集：ExcelApi 1.1 ]

showHeaders

指定标题行是否可见。 该值可以设置为显示或删除标头行。

showHeaders: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

showTotals

指定总行是否可见。 该值可以设置为显示或删除总计行。

showTotals: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.1 ]

style

表示表格样式的常量值。 可能的值为：“TableStyleLight1”到“TableStyleLight21”、“TableStyleMedium1”到“TableStyleMedium28”、“TableStyleDark1”到“TableStyleDark11”。 还可以指定工作簿中显示的用户定义的自定义样式。

style: string;

属性值

string

注解

[ API 集：ExcelApi 1.1 ]

示例

// Set table style.
await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.name = 'Table1-Renamed';
    table.showTotals = false;
    table.style = 'TableStyleMedium2';
    table.load('tableStyle');
    await context.sync();
    
    console.log(table.style);
});

方法详细信息

delete()

删除表。

delete(): void;

返回

void

注解

[ API 集：ExcelApi 1.1 ]

示例

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

getDataBodyRange()

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

getDataBodyRange(): Excel.Range;

返回

Excel.Range

注解

[ API 集：ExcelApi 1.1 ]

示例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableDataRange = table.getDataBodyRange();
    tableDataRange.load('address')
    await context.sync();
    
    console.log(tableDataRange.address);
});

getHeaderRowRange()

获取与表的标题行相关的 range 对象。

getHeaderRowRange(): Excel.Range;

返回

Excel.Range

注解

[ API 集：ExcelApi 1.1 ]

示例

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    const tableHeaderRange = table.getHeaderRowRange();
    tableHeaderRange.load('address');
    await context.sync();

    console.log(tableHeaderRange.address);
});

getRange()

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

getRange(): Excel.Range;

返回

Excel.Range

注解

[ API 集：ExcelApi 1.1 ]

示例

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

getTotalRowRange()

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

getTotalRowRange(): Excel.Range;

返回

Excel.Range

注解

[ API 集：ExcelApi 1.1 ]

示例

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

load(options)

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

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

参数

options

Excel.Interfaces.TableLoadOptions

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

返回

Excel.Table

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.Table

示例

// Get a table by name.
await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.load('id')
    await context.sync();
    
    console.log(table.id);
});

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.Table

set(properties, options)

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

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

参数

properties

Excel.Interfaces.TableUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.Table): void;

参数

properties

Excel.Table

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.TableData;

返回

Excel.Interfaces.TableData