Word.ShadowFormat class
表示 Word 中形状或文本的阴影格式。
属性
| blur | 将阴影格式的模糊级别指定为 0.0 和 100.0 之间的值。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| foreground |
返回 |
| is |
指定对象或应用于它的格式是否可见。 |
| obscured | 指定 |
| offsetX | 指定形状阴影) 的水平偏移 (。 正值表示负值表示阴影向图形; 右侧读它的左侧。 |
| offsetY | 指定形状阴影) 点 (的垂直偏移量。 正值会将阴影偏移到形状顶部;负值会偏移到底部。 |
| rotate |
指定旋转形状时是否旋转阴影。 |
| size | 指定阴影的宽度。 |
| style | 指定要应用于形状的阴影格式的类型。 |
| transparency | 指定阴影的透明度，值介于 0.0 (不透明) 到 1.0 (透明) 之间。 |
| type | 指定形状阴影类型。 |
方法
| increment |
按点数更改阴影的水平偏移量。 递增 要调整的点数。 |
| increment |
按指定磅值更改阴影的垂直偏移量。 递增 要调整的点数。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
blur
context
foregroundColor
返回 ColorFormat 表示填充、线条或阴影的前景色的对象。
readonly foregroundColor: Word.ColorFormat;属性值
注解
isVisible
obscured
指定 true 即使形状没有填充，形状没有填充 false ，如果形状没有填充，并且如果形状没有填充，并且阴影轮廓通过形状可见，则形状的阴影是否以填充形式显示并被形状遮挡。
obscured: boolean;属性值
boolean
注解
offsetX
offsetY
rotateWithShape
size
style
指定要应用于形状的阴影格式的类型。
style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow";属性值
Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"
注解
transparency
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"
注解
方法详细信息
incrementOffsetX(increment)
按点数更改阴影的水平偏移量。 递增 要调整的点数。
incrementOffsetX(increment: number): void;参数
- increment
-
number
返回
void
注解
incrementOffsetY(increment)
按指定磅值更改阴影的垂直偏移量。 递增 要调整的点数。
incrementOffsetY(increment: number): void;参数
- increment
-
number
返回
void
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat;参数
为要加载的对象属性提供选项。
返回
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;