Word.ShapeFill class
表示 Word 的填充格式。形状对象。
注解
使用方
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-geometric-shapes.yaml
await Word.run(async (context) => {
// Gets the color fill properties of the first moon found in the document body.
const moon: Word.Shape = context.document.body.shapes
.getByGeometricTypes([Word.GeometricShapeType.moon])
.getFirstOrNullObject();
moon.load("fill");
await context.sync();
if (moon.isNullObject) {
console.log("No moons found in the document body.");
return;
}
const moonFill: Word.ShapeFill = moon.fill;
const moonFillType = moonFill.type as Word.ShapeFillType;
console.log("Color fill properties of the first moon found in the document body:");
console.log(`\tForeground color: ${moonFill.foregroundColor}`);
console.log(`\tBackground color: ${moonFill.backgroundColor}`);
console.log(`\tTransparency: ${moonFill.transparency}`);
console.log(`\tFill type: ${moonFillType}`);
});
属性
| background |
指定形状填充背景色。 可以以“#RRGGBB”格式或颜色名称提供值。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| foreground |
指定形状填充前景色。 可以以“#RRGGBB”格式或颜色名称提供值。 |
| transparency | 指定填充的透明度百分比，其值从 0.0 (不透明) 到 1.0 (透明) 。 如果形状类型不支持透明度或形状填充具有不一致的透明度（例如渐变填充类型），则返回 |
| type | 返回形状的填充类型。 有关详细信息，请参阅 |
方法
| clear() | 清除此形状的填充格式并将其设置为 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| set |
将形状的填充格式设置为统一颜色。 填充类型会更改为 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
backgroundColor
context
foregroundColor
transparency
指定填充的透明度百分比，其值从 0.0 (不透明) 到 1.0 (透明) 。 如果形状类型不支持透明度或形状填充具有不一致的透明度（例如渐变填充类型），则返回 null 。
transparency: number;属性值
number
注解
type
返回形状的填充类型。 有关详细信息，请参阅 Word.ShapeFillType。
readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";属性值
Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"
注解
方法详细信息
clear()
清除此形状的填充格式并将其设置为 Word.ShapeFillType.noFill。
clear(): void;返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-geometric-shapes.yaml
await Word.run(async (context) => {
// Sets color fill properties of the first moon found in the document body.
const moon: Word.Shape = context.document.body.shapes
.getByGeometricTypes([Word.GeometricShapeType.moon])
.getFirstOrNullObject();
moon.load("fill");
await context.sync();
if (moon.isNullObject) {
console.log("No moons found in the document body.");
return;
}
const moonFill: Word.ShapeFill = moon.fill;
console.log("Current fill properties of the first moon found in the document body:", moonFill);
moonFill.setSolidColor("green");
moonFill.load();
await context.sync();
console.log("Updated color fill properties of the first moon found in the document body:", moonFill);
});
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.ShapeFill;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ShapeFill;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.ShapeFillUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
setSolidColor(color)
将形状的填充格式设置为统一颜色。 填充类型会更改为 Word.ShapeFillType.solid。
setSolidColor(color: string): void;参数
- color
-
string
表示填充前景色的字符串。 可以以“#RRGGBB”格式或颜色名称提供值。
返回
void
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-geometric-shapes.yaml
await Word.run(async (context) => {
// Sets color fill properties of the first moon found in the document body.
const moon: Word.Shape = context.document.body.shapes
.getByGeometricTypes([Word.GeometricShapeType.moon])
.getFirstOrNullObject();
moon.load("fill");
await context.sync();
if (moon.isNullObject) {
console.log("No moons found in the document body.");
return;
}
const moonFill: Word.ShapeFill = moon.fill;
console.log("Current fill properties of the first moon found in the document body:", moonFill);
moonFill.setSolidColor("green");
moonFill.load();
await context.sync();
console.log("Updated color fill properties of the first moon found in the document body:", moonFill);
});
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.ShapeFill 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.ShapeFillData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.ShapeFillData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.ShapeFill;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.ShapeFill;