Word.TableCellCollection class
包含文档Word的集合。TableCell 对象。
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml
// Gets content alignment details about the first cell of the first table in the document.
await Word.run(async (context) => {
const firstTable: Word.Table = context.document.body.tables.getFirst();
const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});
方法
| auto |
改变表格列宽，使之在单元格文本换行方式不变的情况下，适应文本宽度。 |
| delete(shift |
删除表格单元格，并选择性地控制剩余单元格的移动方式。 |
| delete(shift |
删除表格单元格，并选择性地控制剩余单元格的移动方式。 |
| distribute |
将指定单元格调整为等高。 |
| distribute |
将指定单元格调整为等宽。 |
| get |
获取此集合中的第一个表格单元格。 如果此集合为空， |
| get |
获取此集合中的第一个表格单元格。 如果此集合为空，则此方法将返回一个 对象，其 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| merge() | 将指定的单元格合并到单个单元格中。 |
| set |
设置表格中单元格的高度。 |
| set |
设置表格中单元格的高度。 |
| set |
设置表格中单元格的宽度。 |
| set |
设置表格中单元格的宽度。 |
| split(options) | 拆分此表单元格区域。 |
| toJSON() | 重写 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 |
属性详细信息
context
items
方法详细信息
autoFit()
delete(shiftCells)
删除表格单元格，并选择性地控制剩余单元格的移动方式。
delete(shiftCells?: Word.DeleteCells): void;参数
- shiftCells
- Word.DeleteCells
可选。 指定删除后剩余单元格的移动方式。 默认值为 shiftLeft。
返回
void
注解
delete(shiftCells)
删除表格单元格，并选择性地控制剩余单元格的移动方式。
delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void;参数
- shiftCells
-
"ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"
可选。 指定删除后剩余单元格的移动方式。 默认值为 shiftLeft。
返回
void
注解
distributeHeight()
distributeWidth()
getFirst()
获取此集合中的第一个表格单元格。 如果此集合为空， ItemNotFound 则引发错误。
getFirst(): Word.TableCell;返回
注解
getFirstOrNullObject()
获取此集合中的第一个表格单元格。 如果此集合为空，则此方法将返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getFirstOrNullObject(): Word.TableCell;返回
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.TableCellCollection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
merge()
setHeight(rowHeight, heightRule)
设置表格中单元格的高度。
setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;参数
- rowHeight
-
number
要设置的行的高度（以磅为单位）。
- heightRule
- Word.RowHeightRule
用于确定指定行的高度的规则。
返回
void
注解
setHeight(rowHeight, heightRule)
设置表格中单元格的高度。
setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void;参数
- rowHeight
-
number
要设置的行的高度（以磅为单位）。
- heightRule
-
"Auto" | "AtLeast" | "Exactly"
用于确定指定行的高度的规则。
返回
void
注解
setWidth(columnWidth, rulerStyle)
设置表格中单元格的宽度。
setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;参数
- columnWidth
-
number
要设置的行的宽度（以磅为单位）。
- rulerStyle
- Word.RulerStyle
要应用的标尺样式。
返回
void
注解
setWidth(columnWidth, rulerStyle)
设置表格中单元格的宽度。
setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;参数
- columnWidth
-
number
要设置的行的宽度（以磅为单位）。
- rulerStyle
-
"None" | "Proportional" | "FirstColumn" | "SameWidth"
要应用的标尺样式。
返回
void
注解
split(options)
拆分此表单元格区域。
split(options?: Word.TableCellCollectionSplitOptions): void;参数
可选。 用于拆分表格单元格的选项。
返回
void
注解
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 而原始Word.TableCellCollection对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.TableCellCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Word.Interfaces.TableCellCollectionData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。
track(): Word.TableCellCollection;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。
untrack(): Word.TableCellCollection;