Class ConditionalFormatRule

ConditionalFormatRule

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

Methods

メソッド戻り値の型概要
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[] - この条件付き書式ルールが適用される範囲。