Class ConditionalFormatRule

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.
var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
var 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.
var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
var 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.
var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
var ranges = rule.getRanges();
for (var i = 0; i < ranges.length; i++) {
  Logger.log(ranges[i].getA1Notation());
}

回攻員

Range[]：這項條件式格式規則的套用範圍。