Word.TableColumn class
表示 Word 文档中的表列。
属性
| borders | 返回 |
| column |
返回此列在集合中的位置。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| is |
如果列或行是表 |
| is |
如果列或行是表 |
| nesting |
返回列的嵌套级别。 |
| preferred |
指定首选宽度 (（以磅为单位）或表示列窗口宽度) 的百分比。 度量单位可由 |
| preferred |
指定用于表列宽度的首选度量单位。 |
| shading | 返回引用 |
| width | 指定列的宽度（以磅为单位）。 |
方法
| auto |
更改表列的宽度以适应文本的宽度，而不更改文本在单元格中的换行方式。 |
| delete() | 删除列。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| select() | 选择表列。 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| set |
设置表中列的宽度。 |
| set |
设置表中列的宽度。 |
| sort() | 对表列排序。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
borders
返回 BorderUniversalCollection 表示表列的所有边框的对象。
readonly borders: Word.BorderUniversalCollection;属性值
注解
columnIndex
context
isFirst
如果列或行是表false中的第一列或行，则返回true;否则返回。
readonly isFirst: boolean;属性值
boolean
注解
isLast
如果列或行是表false中的最后一列或行，则返回true;否则返回。
readonly isLast: boolean;属性值
boolean
注解
nestingLevel
preferredWidth
指定首选宽度 (（以磅为单位）或表示列窗口宽度) 的百分比。 度量单位可由 preferredWidthType 属性指定。
preferredWidth: number;属性值
number
注解
preferredWidthType
指定用于表列宽度的首选度量单位。
preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points";属性值
Word.PreferredWidthType | "Auto" | "Percent" | "Points"
注解
shading
返回引用 ShadingUniversal 列的底纹格式的对象。
readonly shading: Word.ShadingUniversal;属性值
注解
width
方法详细信息
autoFit()
delete()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.TableColumn;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TableColumn;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
select()
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.TableColumnUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.TableColumnUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
基于现有加载的对象，同时在对象上设置多个属性。
set(properties: Word.TableColumn): void;参数
- properties
- Word.TableColumn
返回
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
注解
sort()
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.TableColumn 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.TableColumnData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.TableColumnData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.TableColumn;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.TableColumn;