Class ConditionalFormatRule

ConditionalFormatRule

条件付き書式設定ルールにアクセスします。新しいルールを作成するには、SpreadsheetApp.newConditionalFormatRule() と ConditionalFormatRuleBuilder を使用します。 Sheet.setConditionalFormatRules(rules) を使用して、特定のシートのルールを設定できます。

ブール条件の条件を使用するルールの場合、書式設定にアクセスできます。 getBooleanCondition() を呼び出し、返された BooleanCondition オブジェクトのメソッドを使用します。

メソッド

メソッド	戻り値の型	概要
copy()	ConditionalFormatRuleBuilder	このルールの設定でプリセットされたルールビルダーを返します。
getBooleanCondition()	BooleanCondition|null	このルールが ブール条件の条件を使用している場合、ルールの BooleanCondition 情報を取得します。
getGradientCondition()	GradientCondition|null	このルールがグラデーション条件の条件を使用している場合、ルールの 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 — ブール条件オブジェクト。ルールがブール条件を使用していない場合は 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 — グラデーション条件オブジェクト。ルールがグラデーション条件を使用していない場合は 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[] — この条件付き書式ルールが適用される範囲。