FormatConditions

本文介绍与表格文档FormatConditions相关的API。

FormatConditions

Range.FormatConditions

获取指定区域中的所有条件格式。

  • 语法

    表达式.Range.FormatConditions

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
    
      //获取区域对象
      const range = await app.Range('A1');
    
      //获取该区域的所有条件格式
      const formatConditions = await range.FormatConditions;
    }

方法

Range.FormatConditions.Add()

通过Add()方法,您可以指定区域添加条件格式。

  • 语法

    表达式.Range.FormatConditions.Add({ Type, Operator, Formula1, Formula2 })

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Type

    Enum

    指定条件格式是基于单元格值还是基于表达式。更多信息,请参见XlFormatConditionType

    Operator

    Number

    条件格式运算符。更多信息,请参见XlFormatConditionOperator

    Formula1

    Number

    与条件格式关联的值或表达式。可为常量值、字符串值、单元格引用或公式。

    Formula2

    Number

    • 当参数Operator取值为xlBetweenxlNotBetween时,该参数表示与条件格式第二部分相关联的值或表达式,可以是常量值、字符串值、单元格引用或公式。

    • 当参数Operator取值不为xlBetweenxlNotBetween时,将忽略此参数。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取区域对象
      const range = await app.Range('A4:D5');
    
      //选中该区域
      await range.Select();
    
      //设置公式
      range.Formula = 'Aliyun';
    
      //获取所有条件格式
      const formatConditions = await range.FormatConditions;
    
      //添加条件格式
      await formatConditions.Add(
        app.Enum.XlFormatConditionType.xlExpression,
        undefined,
        '=D1=1',
      );
    }

Range.FormatConditions.With()

通过With()方法,您可以编辑条件格式。

  • 语法

    表达式.Range.FormatConditions.With({ Interior, Font, Borders })

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Interior

    Object

    内部属性对象。

    Font

    Object

    字体对象。

    Borders

    Object

    边框对象。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取区域对象
      const range = await app.Range('A4:D5');
    
      //选中该区域
      await range.Select();
    
      //设置公式
      range.Formula = 'Aliyun';
    
      //获取所有条件格式
      const formatConditions = await range.FormatConditions;
    
      //添加条件格式
      await formatConditions.Add(
        app.Enum.XlFormatConditionType.xlExpression,
        undefined,
        '=D1=1',
      );
    
      // 编辑条件格式
      await formatConditionsAdd.With({
        Interior: { Color: '#000000' },
        Font: { Bold: true, Color: '#FF0000', Underline: 2, Italic: true, Strikethrough: true },
        Border: { LineStyle: -4119, Color: '#FF0000' },
      });
    }