Excel.ConditionalRangeFormat class

  • 参考
包:
excel

一个格式对象，该对象封装条件格式区域的字体、填充、边框和其他属性。

Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.6 ]

属性

borders

应用于整体条件格式范围的边框对象的集合。
context

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

返回在总体条件格式范围上定义的填充对象。
font

返回在整体条件格式范围上定义的字体对象。
numberFormat

表示给定区域的 Excel 数字格式代码。 有关 Excel 数字格式设置的详细信息，请参阅 数字格式代码。 如果 null 传入 ，则清除。

方法

clearFormat()

从条件格式规则中删除格式属性。 这会创建一个没有格式设置的规则。
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.ConditionalRangeFormat 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.ConditionalRangeFormatData) ，该对象包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

borders

应用于整体条件格式范围的边框对象的集合。

readonly borders: Excel.ConditionalRangeBorderCollection;

属性值

Excel.ConditionalRangeBorderCollection

注解

[ API 集：ExcelApi 1.6 ]

context

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

context: RequestContext;

属性值

Excel.RequestContext

fill

返回在总体条件格式范围上定义的填充对象。

readonly fill: Excel.ConditionalRangeFill;

属性值

Excel.ConditionalRangeFill

注解

[ API 集：ExcelApi 1.6 ]

font

返回在整体条件格式范围上定义的字体对象。

readonly font: Excel.ConditionalRangeFont;

属性值

Excel.ConditionalRangeFont

注解

[ API 集：ExcelApi 1.6 ]

numberFormat

表示给定区域的 Excel 数字格式代码。 有关 Excel 数字格式设置的详细信息，请参阅 数字格式代码。 如果 null 传入 ，则清除。

numberFormat: any;

属性值

any

注解

[ API 集：ExcelApi 1.6 ]

方法详细信息

clearFormat()

从条件格式规则中删除格式属性。 这会创建一个没有格式设置的规则。

clearFormat(): void;

返回

void

注解

[ API 集：ExcelApi 1.17 ]

load(options)

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

load(options?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat;

参数

options
Excel.Interfaces.ConditionalRangeFormatLoadOptions

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

返回

Excel.ConditionalRangeFormat

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ConditionalRangeFormat

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.ConditionalRangeFormat

set(properties, options)

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

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

参数

properties
Excel.Interfaces.ConditionalRangeFormatUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Excel.ConditionalRangeFormat): void;

参数

properties
Excel.ConditionalRangeFormat

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.ConditionalRangeFormatData;

返回

Excel.Interfaces.ConditionalRangeFormatData