OneNote.TableRow class
表示表中的行。
- 扩展
注解
属性
| cell |
获取行中的单元格数。 |
| cells | 获取行中的单元格。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| id | 获取行的 ID。 |
| parent |
获取父表。 |
| row |
获取其父表中的行索引。 |
方法
| clear() | 清除行内容。 |
| insert |
在当前行之前或之后插入一行。 |
| insert |
在当前行之前或之后插入一行。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set |
设置行中所有单元格的底纹色。 要为单元格设置的颜色代码。 |
| toJSON() | 重写 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 |
属性详细信息
cellCount
cells
获取行中的单元格。
readonly cells: OneNote.TableCellCollection;属性值
注解
context
id
parentTable
rowIndex
方法详细信息
clear()
insertRowAsSibling(insertLocation, values)
在当前行之前或之后插入一行。
insertRowAsSibling(insertLocation: OneNote.InsertLocation, values?: string[]): OneNote.TableRow;参数
- insertLocation
- OneNote.InsertLocation
新行应插入的位置对应于当前行。
- values
-
string[]
在新行中插入的字符串，指定为数组。 单元格不能多于当前行中的单元格。 可选。
返回
注解
示例
await OneNote.run(async (context) => {
const app = context.application;
const outline = app.getActiveOutline();
// Queue a command to load outline.paragraphs and their types.
context.load(outline, "paragraphs, paragraphs/type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
const paragraphs = outline.paragraphs;
// For each table, get table rows.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
// Queue a command to load table.rows.
context.load(table, "rows");
// Run the queued commands.
await context.sync();
const rows = table.rows;
rows.items[1].insertRowAsSibling("Before", ["cell0", "cell1"]);
await context.sync();
}
}
});
insertRowAsSibling(insertLocationString, values)
在当前行之前或之后插入一行。
insertRowAsSibling(insertLocationString: "Before" | "After", values?: string[]): OneNote.TableRow;参数
- insertLocationString
-
"Before" | "After"
新行应插入的位置对应于当前行。
- values
-
string[]
在新行中插入的字符串，指定为数组。 单元格不能多于当前行中的单元格。 可选。
返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: OneNote.Interfaces.TableRowLoadOptions): OneNote.TableRow;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): OneNote.TableRow;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
示例
await OneNote.run(async (context) => {
const app = context.application;
const outline = app.getActiveOutline();
// Queue a command to load outline.paragraphs and their types.
context.load(outline, "paragraphs, paragraphs/type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
const paragraphs = outline.paragraphs;
// For each table, get table rows.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
// Queue a command to load table.rows.
context.load(table, "rows");
await context.sync();
const rows = table.rows;
// For each table row, log cell count and row index.
for (let i = 0; i < rows.items.length; i++) {
console.log("Row " + i + " Id: " + rows.items[i].id);
console.log("Row " + i + " Cell Count: " + rows.items[i].cellCount);
console.log("Row " + i + " Row Index: " + rows.items[i].rowIndex);
}
await context.sync();
}
}
});
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): OneNote.TableRow;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
setShadingColor(colorCode)
设置行中所有单元格的底纹色。 要为单元格设置的颜色代码。
setShadingColor(colorCode: string): void;参数
- colorCode
-
string
返回
void
注解
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，依次调用toJSON传递给它的 对象的 方法。) 虽然原始OneNote.TableRow对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 OneNote.Interfaces.TableRowData) ，其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): OneNote.Interfaces.TableRowData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。
track(): OneNote.TableRow;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。
untrack(): OneNote.TableRow;