Excel.TableRow class

包:

excel

表示表中的行。

请注意，与区域或列（如果在它们前面添加新行或列时会进行调整）不同， TableRow 对象表示表行的物理位置，而不是数据。 也就是说，如果对数据进行排序或添加新行，则表行将继续指向创建它的索引。

Extends

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.1 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
index	返回表的行集合内行的索引编号。 从零开始编制索引。
values	表示指定区域的原始值。 返回的数据可以是字符串、数字或布尔值。 包含错误的单元格将返回错误字符串。 如果返回的值以加号 (“+”) 、减 (“-”) 或等号 (“=”) 开头，Excel 会将此值解释为公式。

方法

delete()	从表中删除行。
getRange()	返回与整个行相关的 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.TableRow 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.TableRowData) ，其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

index

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

readonly index: number;

属性值

number

注解

[ API 集：ExcelApi 1.1 ]

values

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

values: any[][];

属性值

any[][]

注解

[ API 集：ExcelApi 1.1 ]

方法详细信息

delete()

从表中删除行。

delete(): void;

返回

void

注解

[ API 集：ExcelApi 1.1 ]

示例

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

getRange()

返回与整个行相关的 range 对象。

getRange(): Excel.Range;

返回

Excel.Range

注解

[ API 集：ExcelApi 1.1 ]

示例

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

load(options)

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

load(options?: Excel.Interfaces.TableRowLoadOptions): Excel.TableRow;

参数

options

Excel.Interfaces.TableRowLoadOptions

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

返回

Excel.TableRow

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.TableRow

示例

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

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.TableRow

set(properties, options)

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

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

参数

properties

Excel.Interfaces.TableRowUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.TableRow): void;

参数

properties

Excel.TableRow

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.TableRowData;

返回

Excel.Interfaces.TableRowData