Word.ShadowFormat class

表示Word中形状或文本的阴影格式。

扩展

注解

[ API 集:WordApiDesktop 1.3 ]

属性

blur

将阴影格式的模糊级别指定为介于 0.0 和 100.0 之间的值。

context

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

foregroundColor

返回一个 ColorFormat 对象,该对象代表填充、线条或阴影的前景色。

isVisible

指定对象或应用于该对象的格式是否可见。

obscured

指定 true 形状的阴影是否显示为填充并且被形状遮盖,即使形状没有填充,如果阴影没有填充, false 并且阴影的轮廓通过形状可见(如果形状没有填充)。

offsetX

指定从形状) 阴影的水平偏移量 (磅。 正值表示负值表示阴影向图形; 右侧读它的左侧。

offsetY

指定垂直偏移量 ((以磅为单位)) 阴影与形状。 正值将阴影偏移到形状顶部;负值将其偏移到底部。

rotateWithShape

指定在旋转形状时是否旋转阴影。

size

指定阴影的宽度。

style

指定要应用于形状的阴影格式的类型。

transparency

将阴影的透明度指定为介于 0.0 (不透明) 和 1.0 (透明) 之间的值。

type

指定形状阴影类型。

方法

incrementOffsetX(increment)

将阴影的水平偏移量更改为磅数。 递增 要调整的点数。

incrementOffsetY(increment)

按指定磅值更改阴影的垂直偏移量。 递增 要调整的点数。

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

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

set(properties)

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

toJSON()

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

track()

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

untrack()

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

属性详细信息

blur

将阴影格式的模糊级别指定为介于 0.0 和 100.0 之间的值。

blur: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.3 ]

context

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

context: RequestContext;

属性值

foregroundColor

返回一个 ColorFormat 对象,该对象代表填充、线条或阴影的前景色。

readonly foregroundColor: Word.ColorFormat;

属性值

注解

[ API 集:WordApiDesktop 1.3 ]

isVisible

指定对象或应用于该对象的格式是否可见。

isVisible: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.3 ]

obscured

指定 true 形状的阴影是否显示为填充并且被形状遮盖,即使形状没有填充,如果阴影没有填充, false 并且阴影的轮廓通过形状可见(如果形状没有填充)。

obscured: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.3 ]

offsetX

指定从形状) 阴影的水平偏移量 (磅。 正值表示负值表示阴影向图形; 右侧读它的左侧。

offsetX: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.3 ]

offsetY

指定垂直偏移量 ((以磅为单位)) 阴影与形状。 正值将阴影偏移到形状顶部;负值将其偏移到底部。

offsetY: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.3 ]

rotateWithShape

指定在旋转形状时是否旋转阴影。

rotateWithShape: boolean;

属性值

boolean

注解

[ API 集:WordApiDesktop 1.3 ]

size

指定阴影的宽度。

size: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.3 ]

style

指定要应用于形状的阴影格式的类型。

style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow";

属性值

Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"

注解

[ API 集:WordApiDesktop 1.3 ]

transparency

将阴影的透明度指定为介于 0.0 (不透明) 和 1.0 (透明) 之间的值。

transparency: number;

属性值

number

注解

[ API 集:WordApiDesktop 1.3 ]

type

指定形状阴影类型。

type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43";

属性值

Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"

注解

[ API 集:WordApiDesktop 1.3 ]

方法详细信息

incrementOffsetX(increment)

将阴影的水平偏移量更改为磅数。 递增 要调整的点数。

incrementOffsetX(increment: number): void;

参数

increment

number

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

incrementOffsetY(increment)

按指定磅值更改阴影的垂直偏移量。 递增 要调整的点数。

incrementOffsetY(increment: number): void;

参数

increment

number

返回

void

注解

[ API 集:WordApiDesktop 1.3 ]

load(options)

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

load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat;

参数

options
Word.Interfaces.ShadowFormatLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

set(properties, options)

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

set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Word.Interfaces.ShadowFormatUpdateData

一个 JavaScript 对象,其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

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

set(properties: Word.ShadowFormat): void;

参数

properties
Word.ShadowFormat

返回

void

toJSON()

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

toJSON(): Word.Interfaces.ShadowFormatData;

返回

track()

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

track(): Word.ShadowFormat;

返回

untrack()

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

untrack(): Word.ShadowFormat;

返回