Excel.ConditionalRangeFormat class
一个格式对象，该对象封装条件格式区域的字体、填充、边框和其他属性。
- 扩展
注解
属性
| borders | 应用于整体条件格式范围的边框对象的集合。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| fill | 返回在总体条件格式范围上定义的填充对象。 |
| font | 返回在总体条件格式范围上定义的字体对象。 |
| number |
表示给定区域的 Excel 数字格式代码。 有关 Excel 数字格式的详细信息，请参阅 数字格式代码。 如果 |
方法
| clear |
从条件格式规则中删除格式属性。 这会创建一个没有格式设置的规则。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
属性详细信息
borders
应用于整体条件格式范围的边框对象的集合。
readonly borders: Excel.ConditionalRangeBorderCollection;属性值
注解
context
fill
返回在总体条件格式范围上定义的填充对象。
readonly fill: Excel.ConditionalRangeFill;属性值
注解
font
返回在总体条件格式范围上定义的字体对象。
readonly font: Excel.ConditionalRangeFont;属性值
注解
numberFormat
方法详细信息
clearFormat()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.ConditionalRangeFormat;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.ConditionalRangeFormat;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.ConditionalRangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
一个 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;