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[] - この条件付き書式ルールが適用される範囲。