ConditionalFormatRules
のブール条件にアクセスします。各条件付き書式ルールには、ブール条件を 1 つ含めることができます。ブール条件自体には、ブール値の条件(値を含む)と書式設定設定が含まれます。条件は、セルの内容に対して評価され、true
または false
値のいずれかになります。この条件が true
と評価された場合、条件の書式設定設定がセルに適用されます。
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getBackgroundObject() | Color | このブール値の条件の背景色を取得します。 |
getBold() | Boolean | このブール条件がテキストを太字にする場合、true を返し、このブール条件によってテキストから太字が取り除かれた場合は false を返します。 |
getCriteriaType() | BooleanCriteria | BooleanCriteria 列挙型で定義されているルールの条件タイプを取得します。 |
getCriteriaValues() | Object[] | ルールの条件に対応する引数の配列を取得します。 |
getFontColorObject() | Color | このブール条件のフォント色を取得します。 |
getItalic() | Boolean | このブール条件がテキストを斜体にした場合は true を返し、このブール条件によってテキストから斜体を削除すると false を返します。 |
getStrikethrough() | Boolean | このブール条件がテキストをストライクした場合は true を返し、このブール条件がテキストから取り消し線を削除すると false を返します。 |
getUnderline() | Boolean | このブール条件がテキストに下線を引く場合は true を返し、このブール条件によってテキストから下線を削除する場合は false を返します。 |
詳細なドキュメント
getBackgroundObject()
このブール値の条件の背景色を取得します。設定されていない場合は null
を返します。
// Logs the boolean condition background color for each conditional format rule on a sheet. var sheet = SpreadsheetApp.getActiveSheet(); var rules = sheet.getConditionalFormatRules(); for (int i = 0; i < rules.length; i++) { var color = rules[i].getBooleanCondition().getBackgroundObject(); Logger.log("The background color for rule %s is %s", i, color.asRgbColor().asHexString()); }
リターン
Color
- 背景色。この条件で設定されていない場合は null
。
getBold()
このブール条件がテキストを太字にする場合、true
を返し、このブール条件によってテキストから太字が取り除かれた場合は false
を返します。太字に影響がなければ、null
を返します。
// Logs the boolean condition font weight for each conditional format rule on a sheet. var sheet = SpreadsheetApp.getActiveSheet(); var rules = sheet.getConditionalFormatRules(); for (int i = 0; i < rules.length; i++) { var bold = rules[i].getBooleanCondition().getBold(); Logger.log("The font bold setting for rule %s is %b", i, weight); }
リターン
Boolean
- ブール条件によってテキストを太字にするかどうか。太字に影響しない場合は null
getCriteriaType()
BooleanCriteria
列挙型で定義されているルールの条件タイプを取得します。条件の引数を取得するには、getCriteriaValues()
を使用します。これらの値を使用して条件付き書式ルールを作成または変更する方法については、ConditionalFormatRuleBuilder.withCriteria(criteria, args)
をご覧ください。
// Log information about the conditional formats on the active sheet that use // boolean conditions. var sheet = SpreadsheetApp.getActiveSheet; var formats = sheet.getConditionalFormats(); sheet.getConditionalFormats().forEach(function(format) { var booleanCondition = format.getBooleanCondition(); if (booleanCondition) { var criteria = booleanCondition.getCriteriaType(); var args = booleanCondition.getCriteriaValues(); Logger.log('The conditional format rule is %s %s', criteria, args); } });
リターン
BooleanCriteria
- 条件付き書式の条件のタイプ
getCriteriaValues()
ルールの条件に対応する引数の配列を取得します。条件タイプを取得するには、getCriteriaType()
を使用します。これらの値を使用して条件付き書式ルールを作成または変更する方法については、ConditionalFormatRuleBuilder.withCriteria(criteria, args)
をご覧ください。
// Log information about the conditional formats on the active sheet that use // boolean conditions. var sheet = SpreadsheetApp.getActiveSheet; var formats = sheet.getConditionalFormats(); sheet.getConditionalFormats().forEach(function(format) { var booleanCondition = format.getBooleanCondition(); if (booleanCondition) { var criteria = booleanCondition.getCriteriaType(); var args = booleanCondition.getCriteriaValues(); Logger.log('The conditional format rule is %s %s', criteria, args); } });
リターン
Object[]
- ルールの条件タイプに適した引数の配列。引数の数とその型は、ConditionalFormatRuleBuilder
クラスの対応する when...()
メソッドと一致します。
getFontColorObject()
このブール条件のフォント色を取得します。設定されていない場合は null
を返します。
// Logs the boolean condition font color for each conditional format rule on a sheet. var sheet = SpreadsheetApp.getActiveSheet(); var rules = sheet.getConditionalFormatRules(); for (int i = 0; i < rules.length; i++) { var color = rules[i].getBooleanCondition().getFontColorObject(); Logger.log("The font color for rule %s is %s", i, color.asRgbColor().asHexString()); }
リターン
Color
- フォントの色。この条件で設定されていない場合は null
。
getItalic()
このブール条件がテキストを斜体にした場合は true
を返し、このブール条件によってテキストから斜体を削除すると false
を返します。斜体に変化がない場合、null
を返します。
// Logs the boolean condition font style for each conditional format rule on a sheet. var sheet = SpreadsheetApp.getActiveSheet(); var rules = sheet.getConditionalFormatRules(); for (int i = 0; i < rules.length; i++) { var italic = rules[i].getBooleanCondition().getItalic(); Logger.log("The font italic setting for rule %s is %b", i, italic); }
リターン
Boolean
- ブール条件でテキストを斜体にするかどうかを指定します。斜体が影響を受けない場合には null
を指定します。
getStrikethrough()
このブール条件がテキストをストライクした場合は true
を返し、このブール条件がテキストから取り消し線を削除すると false
を返します。取り消し線が影響を受けていない場合は、null
を返します。
// Logs the boolean condition strikethrough setting for each conditional format rule on a // sheet. var sheet = SpreadsheetApp.getActiveSheet(); var rules = sheet.getConditionalFormatRules(); for (int i = 0; i < rules.length; i++) { var strikethrough = rules[i].getBooleanCondition().getStrikethrough(); Logger.log("The font strikethrough setting for rule %s is %b", i, strikethrough); }
リターン
Boolean
- ブール条件がテキストに取り消し線を適用するかどうか。取り消し線が影響を受けていない場合は null
。
getUnderline()
このブール条件がテキストに下線を引く場合は true
を返し、このブール条件によってテキストから下線を削除する場合は false
を返します。下線が影響を受けない場合、null
を返します。
// Logs the boolean condition underline setting for each conditional format rule on a sheet. var sheet = SpreadsheetApp.getActiveSheet(); var rules = sheet.getConditionalFormatRules(); for (int i = 0; i < rules.length; i++) { var underline = rules[i].getBooleanCondition().getUnderline(); Logger.log("The font underline setting for rule %s is %b", i, underline); }
リターン
Boolean
- ブール条件でテキストに下線を引くかどうか。下線が影響を受ける場合は null
です。