Excel.RangeFill class

  • 参考
包:
excel

表示 range 对象的背景。

Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.1 ]

属性

color

表示背景颜色的 HTML 颜色代码，格式#RRGGBB (例如“FFA500”) ，或作为命名 HTML 颜色 (，例如“橙色”)

context

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

范围的模式。 有关详细信息，请参阅 Excel.FillPattern。 不支持 LinearGradient 和 RectangularGradient。 值 null 指示整个区域没有统一模式设置。
patternColor

表示范围图案颜色的 HTML 颜色代码，格式#RRGGBB (例如“FFA500”) ，或作为命名的 HTML 颜色 (，例如“橙色”) 。
patternTintAndShade

指定一个使范围填充的图案颜色变亮或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 patternTintAndShade 设置。
tintAndShade

指定为范围填充的颜色变亮或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 tintAndShade 设置。

方法

clear()

重置区域背景。
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传递给它的 对象的 方法。) 而原始 Excel.RangeFill 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.RangeFillData) ，其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

color

表示背景颜色的 HTML 颜色代码，格式#RRGGBB (例如“FFA500”) ，或作为命名 HTML 颜色 (，例如“橙色”) 

color: string;

属性值

string

注解

[ API 集：ExcelApi 1.1 ]

context

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

context: RequestContext;

属性值

Excel.RequestContext

pattern

范围的模式。 有关详细信息，请参阅 Excel.FillPattern。 不支持 LinearGradient 和 RectangularGradient。 值 null 指示整个区域没有统一模式设置。

pattern: Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient";

属性值

Excel.FillPattern | "None" | "Solid" | "Gray50" | "Gray75" | "Gray25" | "Horizontal" | "Vertical" | "Down" | "Up" | "Checker" | "SemiGray75" | "LightHorizontal" | "LightVertical" | "LightDown" | "LightUp" | "Grid" | "CrissCross" | "Gray16" | "Gray8" | "LinearGradient" | "RectangularGradient"

注解

[ API 集：ExcelApi 1.9 ]

patternColor

表示范围图案颜色的 HTML 颜色代码，格式#RRGGBB (例如“FFA500”) ，或作为命名的 HTML 颜色 (，例如“橙色”) 。

patternColor: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

patternTintAndShade

指定一个使范围填充的图案颜色变亮或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 patternTintAndShade 设置。

patternTintAndShade: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

tintAndShade

指定为范围填充的颜色变亮或变暗的双精度值。 该值介于 -1 (最暗) 和 1 (最亮) 之间，原始颜色为 0。 一个 null 值指示该区域没有统一 tintAndShade 设置。

tintAndShade: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

clear()

重置区域背景。

clear(): void;

返回

void

注解

[ API 集：ExcelApi 1.1 ]

示例

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.clear();
    await context.sync(); 
});

load(options)

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

load(options?: Excel.Interfaces.RangeFillLoadOptions): Excel.RangeFill;

参数

options
Excel.Interfaces.RangeFillLoadOptions

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

返回

Excel.RangeFill

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.RangeFill

示例

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFill = range.format.fill;
    rangeFill.load('color');
    await context.sync();
    console.log(rangeFill.color);
});

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.RangeFill

set(properties, options)

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

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

参数

properties
Excel.Interfaces.RangeFillUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.RangeFill): void;

参数

properties
Excel.RangeFill

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.RangeFillData;

返回

Excel.Interfaces.RangeFillData