Word.ConditionalStyle class

用指定的表格样式设置选定表格的格式时,该对象代表应用于表格中指定区域的特殊格式。

扩展

注解

[ API 集:WordApiDesktop 1.4 ]

属性

borders

返回一个 BorderUniversalCollection 对象,该对象代表条件样式的所有边框。

bottomPadding

指定要在单个单元格或表格中所有单元格的内容下面添加的) 以磅为单位的空间 (量。

context

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

font

返回一个 Font 对象,该对象代表条件样式的字体格式。

leftPadding

指定要添加到单个单元格或表格中所有单元格内容的左侧) 以磅为单位的空间 (量。

paragraphFormat

返回一个 ParagraphFormat 对象,该对象代表条件样式的段落格式。

rightPadding

指定要添加到单个单元格或表格中所有单元格右侧的) 以磅为单位的空间 (量。

shading

返回一个 ShadingUniversal 对象,该对象表示条件样式的底纹。

topPadding

指定要在单个单元格或表格中所有单元格的内容上方添加) (磅的空间量(以磅为单位)。

方法

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

track()

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

untrack()

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

属性详细信息

borders

返回一个 BorderUniversalCollection 对象,该对象代表条件样式的所有边框。

readonly borders: Word.BorderUniversalCollection;

属性值

注解

[ API 集:WordApiDesktop 1.4 ]

bottomPadding

指定要在单个单元格或表格中所有单元格的内容下面添加的) 以磅为单位的空间 (量。

bottomPadding: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

context

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

context: RequestContext;

属性值

font

返回一个 Font 对象,该对象代表条件样式的字体格式。

readonly font: Word.Font;

属性值

注解

[ API 集:WordApiDesktop 1.4 ]

leftPadding

指定要添加到单个单元格或表格中所有单元格内容的左侧) 以磅为单位的空间 (量。

leftPadding: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

paragraphFormat

返回一个 ParagraphFormat 对象,该对象代表条件样式的段落格式。

readonly paragraphFormat: Word.ParagraphFormat;

属性值

注解

[ API 集:WordApiDesktop 1.4 ]

rightPadding

指定要添加到单个单元格或表格中所有单元格右侧的) 以磅为单位的空间 (量。

rightPadding: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

shading

返回一个 ShadingUniversal 对象,该对象表示条件样式的底纹。

readonly shading: Word.ShadingUniversal;

属性值

注解

[ API 集:WordApiDesktop 1.4 ]

topPadding

指定要在单个单元格或表格中所有单元格的内容上方添加) (磅的空间量(以磅为单位)。

topPadding: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.4 ]

方法详细信息

load(options)

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

load(options?: Word.Interfaces.ConditionalStyleLoadOptions): Word.ConditionalStyle;

参数

options
Word.Interfaces.ConditionalStyleLoadOptions

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

返回

load(propertyNames)

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

load(propertyNames?: string | string[]): Word.ConditionalStyle;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.ConditionalStyle;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand 一个逗号分隔的字符串,指定要加载的导航属性。

返回

toJSON()

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

toJSON(): Word.Interfaces.ConditionalStyleData;

返回

track()

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

track(): Word.ConditionalStyle;

返回

untrack()

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

untrack(): Word.ConditionalStyle;

返回