PowerPoint.Table class
表示表。
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
// Updates a table's values.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
// Add a table (which is a type of Shape).
const shape = shapes.addTable(4, 3);
let table = shape.getTable();
table.load();
await context.sync();
// Update values in the table.
for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
const cell = table.getCellOrNullObject(rowIndex, columnIndex);
cell.text = generateRandomString();
}
}
await context.sync();
});
属性
column |
获取表中的列数。 |
columns | 获取表中列的集合。 |
context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
row |
获取表格中的行数。 |
rows | 获取表中行的集合。 |
style |
获取表格样式选项。 |
values | 获取表中的所有值。 |
方法
clear(options) | 清除表值和格式设置。 |
get |
获取指定 |
get |
获取表示表合并区域的单元格的集合。 |
get |
获取表的形状对象。 |
load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
merge |
从 rowIndex 和 columnIndex 指定的单元格开始创建合并区域。 合并区域跨越指定数量的行和列。 |
toJSON() | 重写 JavaScript |
属性详细信息
columnCount
columns
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取表中列的集合。
readonly columns: PowerPoint.TableColumnCollection;
属性值
注解
context
rowCount
rows
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取表中行的集合。
readonly rows: PowerPoint.TableRowCollection;
属性值
注解
styleOptions
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取表格样式选项。
readonly styleOptions: PowerPoint.TableStyleOptions;
属性值
注解
values
方法详细信息
clear(options)
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
清除表值和格式设置。
clear(options?: PowerPoint.TableClearOptions): void;
参数
- options
- PowerPoint.TableClearOptions
提供用于清除表的选项。
返回
void
注解
getCellOrNullObject(rowIndex, columnIndex)
获取指定 rowIndex
和 columnIndex
处的单元格。
getCellOrNullObject(rowIndex: number, columnIndex: number): PowerPoint.TableCell;
参数
- rowIndex
-
number
单元格的从零开始的行索引。
- columnIndex
-
number
单元格的从零开始的列索引。
返回
位于指定行和列的单元格。 如果单元格是合并区域的一部分,而不是合并区域的左上角单元格,则返回属性设置为 true
的对象isNullObject
。 有关详细信息,请参阅 *OrNullObject 方法和属性。
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/add-modify-tables.yaml
// Updates a table's values.
await PowerPoint.run(async (context) => {
const shapes = context.presentation.getSelectedSlides().getItemAt(0).shapes;
// Add a table (which is a type of Shape).
const shape = shapes.addTable(4, 3);
let table = shape.getTable();
table.load();
await context.sync();
// Update values in the table.
for (let rowIndex = 0; rowIndex < table.rowCount; rowIndex++) {
for (let columnIndex = 0; columnIndex < table.columnCount; columnIndex++) {
const cell = table.getCellOrNullObject(rowIndex, columnIndex);
cell.text = generateRandomString();
}
}
await context.sync();
});
getMergedAreas()
获取表示表合并区域的单元格的集合。
getMergedAreas(): PowerPoint.TableCellCollection;
返回
, TableCellCollection
包含表示表合并区域的单元格。
注解
getShape()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(options?: PowerPoint.Interfaces.TableLoadOptions): PowerPoint.Table;
参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(propertyNames?: string | string[]): PowerPoint.Table;
参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.Table;
参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand
一个逗号分隔的字符串,指定要加载的导航属性。
返回
mergeCells(rowIndex, columnIndex, rowCount, columnCount)
注意
此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
从 rowIndex 和 columnIndex 指定的单元格开始创建合并区域。 合并区域跨越指定数量的行和列。
mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number): void;
参数
- rowIndex
-
number
要启动合并区域的单元格的从零开始的行索引。
- columnIndex
-
number
要启动合并区域的单元格的从零开始的列索引。
- rowCount
-
number
要与起始单元格合并的行数。 必须大于 0。
- columnCount
-
number
要与起始单元格合并的列数。 必须大于 0。
返回
void
注解
toJSON()
重写 JavaScript toJSON()
方法,以便在将 API 对象传递给 JSON.stringify()
时提供更有用的输出。
JSON.stringify
(,依次调用toJSON
传递给它的 对象的 方法。) 虽然原始PowerPoint.Table
对象是 API 对象,toJSON
但该方法返回一个纯 JavaScript 对象, (类型为 PowerPoint.Interfaces.TableData
) ,其中包含从原始对象加载的任何子属性的浅表副本。
toJSON(): PowerPoint.Interfaces.TableData;