Word.TableColumn class

表示Word文档中的表格列。

扩展

注解

[ API 集:WordApiDesktop 1.3 ]

属性

borders

返回一个 BorderUniversalCollection 对象,该对象代表表列的所有边框。

columnIndex

返回此列在集合中的位置。

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

isFirst

true如果列或行是表中的第一个列或行,则返回 ;false否则返回 。

isLast

true如果列或行是表中的最后一行,则返回 ;false否则返回 。

nestingLevel

返回列的嵌套级别。

preferredWidth

指定首选宽度 ((以磅为单位),或者指定列) 窗口宽度的百分比。 度量单位可由 属性指定 preferredWidthType

preferredWidthType

指定要用于表列宽度的首选度量单位。

shading

返回一个 ShadingUniversal 对象,该对象引用列的底纹格式。

width

指定列的宽度(以磅为单位)。

方法

autoFit()

更改表格列的宽度以适应文本的宽度,而不更改单元格中文本的换行方式。

delete()

删除列。

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

select()

选择表列。

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象,也可以传递同一类型的另一个 API 对象。

set(properties)

基于现有的已加载对象,同时对对象设置多个属性。

setWidth(columnWidth, rulerStyle)

设置表中列的宽度。

setWidth(columnWidth, rulerStyle)

设置表中列的宽度。

sort()

对表列进行排序。

toJSON()

重写 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (,依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.TableColumn对象是 API 对象,toJSON但该方法返回一个纯 JavaScript 对象, (类型为 Word.Interfaces.TableColumnData) ,其中包含从原始对象加载的任何子属性的浅表副本。

track()

根据文档中的相应更改来跟踪对象,以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象,并在设置属性或调用对象方法时收到“InvalidObjectPath”错误,则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分,则还应跟踪父集合。

untrack()

释放与此对象关联的内存(如果先前已跟踪过)。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度,因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前,需要调用 context.sync()

属性详细信息

borders

返回一个 BorderUniversalCollection 对象,该对象代表表列的所有边框。

readonly borders: Word.BorderUniversalCollection;

属性值

注解

[ API 集:WordApiDesktop 1.3 ]

columnIndex

返回此列在集合中的位置。

readonly columnIndex: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.3 ]

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

isFirst

true如果列或行是表中的第一个列或行,则返回 ;false否则返回 。

readonly isFirst: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.3 ]

isLast

true如果列或行是表中的最后一行,则返回 ;false否则返回 。

readonly isLast: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.3 ]

nestingLevel

返回列的嵌套级别。

readonly nestingLevel: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.3 ]

preferredWidth

指定首选宽度 ((以磅为单位),或者指定列) 窗口宽度的百分比。 度量单位可由 属性指定 preferredWidthType

preferredWidth: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.3 ]

preferredWidthType

指定要用于表列宽度的首选度量单位。

preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points";

属性值

Word.PreferredWidthType | "Auto" | "Percent" | "Points"

注解

[ API 集:WordApiDesktop 1.3 ]

shading

返回一个 ShadingUniversal 对象,该对象引用列的底纹格式。

readonly shading: Word.ShadingUniversal;

属性值

注解

[ API 集:WordApiDesktop 1.3 ]

width

指定列的宽度(以磅为单位)。

width: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.3 ]

方法详细信息

autoFit()

更改表格列的宽度以适应文本的宽度,而不更改单元格中文本的换行方式。

autoFit(): void;

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

delete()

删除列。

delete(): void;

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(options?: Word.Interfaces.TableColumnLoadOptions): Word.TableColumn;

参数

options
Word.Interfaces.TableColumnLoadOptions

提供要加载对象的属性的选项。

返回

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()

选择表列。

select(): void;

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

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

注解

[ API 集:WordApiDesktop 1.3 ]

setWidth(columnWidth, rulerStyle)

设置表中列的宽度。

setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

参数

columnWidth

number

要设置的宽度。

rulerStyle

"None" | "Proportional" | "FirstColumn" | "SameWidth"

要应用的标尺样式。

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

sort()

对表列进行排序。

sort(): void;

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

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;

返回