Word.TableColumnCollection class
表示Word的集合。Word文档中的 TableColumn 对象。
注解
方法
| add(before |
返回一个 |
| auto |
改变表格列宽,使之在单元格文本换行方式不变的情况下,适应文本宽度。 |
| delete() | 删除指定列。 |
| distribute |
将指定列调整为等宽。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| select() | 选择指定表格列。 |
| set |
设置表格列的宽度。 |
| set |
设置表格列的宽度。 |
| toJSON() | 重写 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 |
| untrack() | 释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前,需要调用 |
属性详细信息
context
items
方法详细信息
add(beforeColumn)
返回一个 TableColumn 对象,该对象表示添加到表中的列。
add(beforeColumn?: Word.TableColumn): Word.TableColumn;
参数
- beforeColumn
- Word.TableColumn
可选。 在新列之前添加的列。
返回
一个新的 TableColumn 对象。
注解
autoFit()
delete()
distributeWidth()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.TableColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableColumnCollection;
参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.TableColumnCollection;
参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableColumnCollection;
参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。
返回
select()
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
注解
toJSON()
重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(,反过来,调用toJSON传递给它的 对象的 方法。) 而原始Word.TableColumnCollection对象是 API 对象,toJSON该方法返回一个纯 JavaScript 对象, (类型为 Word.Interfaces.TableColumnCollectionData) ,其中包含一个“items”数组,其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Word.Interfaces.TableColumnCollectionData;
返回
track()
根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象,并在设置属性或调用对象方法时收到“InvalidObjectPath”错误,则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分,则还应跟踪父集合。
track(): Word.TableColumnCollection;
返回
untrack()
释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前,需要调用 context.sync() 。
untrack(): Word.TableColumnCollection;