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[]：套用這項條件式格式規則的範圍。