Class ConditionalFormatRule

条件格式规则

访问条件格式规则。如需创建新规则，请使用 SpreadsheetApp.newConditionalFormatRule() 和 ConditionalFormatRuleBuilder。 您可以使用 Sheet.setConditionalFormatRules(rules) 为指定工作表设置规则。

方法

方法	返回类型	简介
copy()	ConditionalFormatRuleBuilder	返回包含相应规则设置的规则构建器预设。
getBooleanCondition()	BooleanCondition	如果相应规则使用布尔值条件标准，则检索该规则的 BooleanCondition 信息。
getGradientCondition()	GradientCondition	如果相应规则使用梯度条件标准，则检索该规则的 GradientCondition 信息。
getRanges()	Range[]	检索应用了相应条件格式规则的范围。

详细文档

copy()

返回包含相应规则设置的规则构建器预设。

返回

ConditionalFormatRuleBuilder - 基于相应规则设置的构建器。

---

getBooleanCondition()

如果相应规则使用布尔值条件标准，则检索该规则的 BooleanCondition 信息。否则返回 null。

// Log the boolean criteria type of the first conditional format rules of a
// sheet.
const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
const booleanCondition = rule.getBooleanCondition();
if (booleanCondition != null) {
  Logger.log(booleanCondition.getCriteriaType());
}

返回

BooleanCondition - 布尔值条件对象；如果规则不使用布尔值条件，则为 null。

---

getGradientCondition()

如果相应规则使用梯度条件标准，则检索该规则的 GradientCondition 信息。否则返回 null。

// Log the gradient minimum color of the first conditional format rule of a
// sheet.
const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
const gradientCondition = rule.getGradientCondition();
if (gradientCondition != null) {
  // Assume the color has ColorType.RGB.
  Logger.log(gradientCondition.getMinColorObject().asRgbColor().asHexString());
}

返回

GradientCondition - 梯度条件对象，如果规则不使用梯度条件，则为 null。

---

getRanges()

检索应用了相应条件格式规则的范围。

// Log each range of the first conditional format rule of a sheet.
const rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
const ranges = rule.getRanges();
for (let i = 0; i < ranges.length; i++) {
  Logger.log(ranges[i].getA1Notation());
}

返回

Range[] - 应用相应条件格式规则的范围。