Word.Interfaces.StyleLoadOptions interface

包:

word

表示Word文档中的样式。

注解

[ API 集：WordApi 1.3 ]

属性

$all	$all为 LoadOptions 指定将加载所有标量属性 (例如：Range.address) 但不加载导航属性 (例如： Range.format.fill.color) 。
baseStyle	指定要用作另一个样式的基本格式的现有样式的名称。
borders	指定一个 BorderCollection 对象，该对象代表指定样式的所有边框。
builtIn	获取指定的样式是否为内置样式。
description	获取指定样式的说明。
font	获取表示指定样式的字符格式的字体对象。
inUse	获取指定的样式是已在文档中修改或应用的内置样式，还是已在文档中创建的新样式。
linked	获取样式是否为可用于段落和字符格式的链接样式。
listTemplate	获取一个 ListTemplate 对象，该对象代表指定 Style 对象的列表格式。
nameLocal	获取以用户语言表示的样式的名称。
nextParagraphStyle	指定要自动应用于新段落的样式名称，该段落在具有指定样式格式的段落之后插入。
paragraphFormat	获取一个 ParagraphFormat 对象，该对象代表指定样式的段落设置。
priority	指定优先级。
quickStyle	指定样式是否对应于可用的快速样式。
shading	获取一个底纹对象，该对象代表指定样式的底纹。 不适用于列表样式。
tableStyle	获取一个 TableStyle 对象，该对象表示可应用于表的 Style 属性。
type	获取样式类型。
unhideWhenUsed	指定在文档中使用指定样式后，是否在 Microsoft Word的“样式”和“样式”任务窗格中将其显示为推荐样式。
visibility	指定指定样式是否在“样式”库和“样式”任务窗格中显示为推荐样式。

属性详细信息

$all

$all为 LoadOptions 指定将加载所有标量属性 (例如：Range.address) 但不加载导航属性 (例如： Range.format.fill.color) 。

$all?: boolean;

属性值

boolean

baseStyle

指定要用作另一个样式的基本格式的现有样式的名称。

baseStyle?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

注意：WordApi 1.6 中引入了设置 baseStyle 功能。

borders

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

指定一个 BorderCollection 对象，该对象代表指定样式的所有边框。

borders?: Word.Interfaces.BorderCollectionLoadOptions;

属性值

Word.Interfaces.BorderCollectionLoadOptions

注解

[ API 集：WordApi BETA (仅预览版) ]

builtIn

获取指定的样式是否为内置样式。

builtIn?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

description

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取指定样式的说明。

description?: boolean;

属性值

boolean

注解

[ API 集：WordApi BETA (仅预览版) ]

font

获取表示指定样式的字符格式的字体对象。

font?: Word.Interfaces.FontLoadOptions;

属性值

Word.Interfaces.FontLoadOptions

注解

[ API 集：WordApi 1.5 ]

inUse

获取指定的样式是已在文档中修改或应用的内置样式，还是已在文档中创建的新样式。

inUse?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

linked

获取样式是否为可用于段落和字符格式的链接样式。

linked?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

listTemplate

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取一个 ListTemplate 对象，该对象代表指定 Style 对象的列表格式。

listTemplate?: Word.Interfaces.ListTemplateLoadOptions;

属性值

Word.Interfaces.ListTemplateLoadOptions

注解

[ API 集：WordApi BETA (仅预览版) ]

nameLocal

获取以用户语言表示的样式的名称。

nameLocal?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

nextParagraphStyle

指定要自动应用于新段落的样式名称，该段落在具有指定样式格式的段落之后插入。

nextParagraphStyle?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

注意：WordApi 1.6 中引入了设置 nextParagraphStyle 功能。

paragraphFormat

获取一个 ParagraphFormat 对象，该对象代表指定样式的段落设置。

paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;

属性值

Word.Interfaces.ParagraphFormatLoadOptions

注解

[ API 集：WordApi 1.5 ]

priority

指定优先级。

priority?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

quickStyle

指定样式是否对应于可用的快速样式。

quickStyle?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

shading

获取一个底纹对象，该对象代表指定样式的底纹。 不适用于列表样式。

shading?: Word.Interfaces.ShadingLoadOptions;

属性值

Word.Interfaces.ShadingLoadOptions

注解

[ API 集：WordApi 1.6 ]

tableStyle

获取一个 TableStyle 对象，该对象表示可应用于表的 Style 属性。

tableStyle?: Word.Interfaces.TableStyleLoadOptions;

属性值

Word.Interfaces.TableStyleLoadOptions

注解

[ API 集：WordApi 1.6 ]

type

获取样式类型。

type?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

unhideWhenUsed

指定在文档中使用指定样式后，是否在 Microsoft Word的“样式”和“样式”任务窗格中将其显示为推荐样式。

unhideWhenUsed?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]

visibility

指定指定样式是否在“样式”库和“样式”任务窗格中显示为推荐样式。

visibility?: boolean;

属性值

boolean

注解

[ API 集：WordApi 1.5 ]