Excel.ShapeFill class

包:

excel

表示形状对象的填充格式。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.9 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
foregroundColor	以 HTML 颜色格式表示形状填充前景色，在窗体 #RRGGBB (例如“FFA500”) 或作为命名的 HTML 颜色 (例如“橙色”)
transparency	将填充的透明度百分比指定为从 0.0 (不透明) 到 1.0 (清除) 的值。 null如果形状类型不支持透明度或形状填充的透明度不一致（例如渐变填充类型），则返回 。
type	返回形状的填充类型。 有关详细信息，请参阅 Excel.ShapeFillType。

方法

clear()	清除此形状的填充格式。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
setSolidColor(color)	将形状的填充格式设置为统一颜色。 这样可将填充类型更改为“Solid”。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.ShapeFill对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ShapeFillData) ，其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Excel.RequestContext

foregroundColor

以 HTML 颜色格式表示形状填充前景色，在窗体 #RRGGBB (例如“FFA500”) 或作为命名的 HTML 颜色 (例如“橙色”)

foregroundColor: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

transparency

将填充的透明度百分比指定为从 0.0 (不透明) 到 1.0 (清除) 的值。 null如果形状类型不支持透明度或形状填充的透明度不一致（例如渐变填充类型），则返回 。

transparency: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

type

返回形状的填充类型。 有关详细信息，请参阅 Excel.ShapeFillType。

readonly type: Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed";

属性值

Excel.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "PictureAndTexture" | "Mixed"

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

clear()

清除此形状的填充格式。

clear(): void;

返回

void

注解

[ API 集：ExcelApi 1.9 ]

load(options)

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

load(options?: Excel.Interfaces.ShapeFillLoadOptions): Excel.ShapeFill;

参数

options

Excel.Interfaces.ShapeFillLoadOptions

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

返回

Excel.ShapeFill

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.ShapeFill;

参数

propertyNames

string | string[]

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

返回

Excel.ShapeFill

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ShapeFill;

参数

propertyNamesAndPaths

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

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

返回

Excel.ShapeFill

set(properties, options)

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

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

参数

properties

Excel.Interfaces.ShapeFillUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.ShapeFill): void;

参数

properties

Excel.ShapeFill

返回

void

setSolidColor(color)

将形状的填充格式设置为统一颜色。 这样可将填充类型更改为“Solid”。

setSolidColor(color: string): void;

参数

color

string

一个字符串，表示 HTML 颜色格式的填充颜色，格式 #RRGGBB (例如“FFA500”) 或命名的 HTML 颜色 (，例如“orange”) 。

返回

void

注解

[ API 集：ExcelApi 1.9 ]

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.ShapeFill对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ShapeFillData) ，其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Excel.Interfaces.ShapeFillData;

返回

Excel.Interfaces.ShapeFillData