Class BooleanCondition

BooleanCondition

ConditionalFormatRules でブール値の条件にアクセスします。各条件付き書式ルールには、1 つのブール条件を含めることができます。ブール条件自体には、ブール条件（値を含む）と形式設定が含まれています。条件はセルの内容と照合され、true 値または false 値が返されます。条件が true と評価された場合、条件の書式設定がセルに適用されます。

メソッド

メソッド戻り値の型概要
getBackgroundObject()Colorこのブール条件の背景色を取得します。
getBold()Booleanこのブール値の条件でテキストが太字になった場合は true を返し、このブール値の条件でテキストから太字が削除された場合は false を返します。
getCriteriaType()BooleanCriteriaBooleanCriteria 列挙型で定義されているルールの条件タイプを取得します。
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.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const color = rule.getBooleanCondition().getBackgroundObject();
  Logger.log(`Background color: ${color.asRgbColor().asHexString()}`);
}

戻る

Color - 背景色。この条件に設定されていない場合は null です。

getBold()

このブール値の条件でテキストが太字になった場合は true を返し、このブール値の条件でテキストから太字が削除された場合は false を返します。太字が影響を受けない場合は null を返します。 

// Logs the boolean condition font weight for each conditional format rule on a
// sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const bold = rule.getBooleanCondition().getBold();
  Logger.log(`Bold: ${bold}`);
}

戻る

Boolean - ブール値の条件でテキストを太字にするかどうか。太字にしない場合は null です。

getCriteriaType()

BooleanCriteria 列挙型で定義されているルールの条件タイプを取得します。条件の引数を取得するには、getCriteriaValues() を使用します。これらの値を使用して条件付き書式設定ルールを作成または変更するには、ConditionalFormatRuleBuilder.withCriteria(criteria, args) をご覧ください。

// Log information about the conditional formats on the active sheet that use
// boolean conditions.

const formats = SpreadsheetApp.getActiveSheet.getConditionalFormats();
SpreadsheetApp.getActiveSheet.getConditionalFormats().forEach((format) => {
  const booleanCondition = format.getBooleanCondition();
  if (booleanCondition) {
    const criteria = booleanCondition.getCriteriaType();
    const args = booleanCondition.getCriteriaValues();
    Logger.log(`The conditional format rule is ${criteria} ${args}`);
  }
});

戻る

BooleanCriteria - 条件付き書式の条件のタイプ。

getCriteriaValues()

ルールの条件の引数の配列を取得します。条件のタイプを取得するには、getCriteriaType() を使用します。これらの値を使用して条件付き書式設定ルールを作成または変更するには、ConditionalFormatRuleBuilder.withCriteria(criteria, args) をご覧ください。

// Log information about the conditional formats on the active sheet that use
// boolean conditions.

const formats = SpreadsheetApp.getActiveSheet.getConditionalFormats();
SpreadsheetApp.getActiveSheet.getConditionalFormats().forEach((format) => {
  const booleanCondition = format.getBooleanCondition();
  if (booleanCondition) {
    const criteria = booleanCondition.getCriteriaType();
    const args = booleanCondition.getCriteriaValues();
    Logger.log(`The conditional format rule is ${criteria} ${args}`);
  }
});

戻る

Object[] - ルールの条件タイプに適した引数の配列。引数の数と型は、ConditionalFormatRuleBuilder クラスの対応する when...() メソッドと一致します。

getFontColorObject()

このブール値条件のフォントの色を取得します。設定されていない場合は null を返します。

// Logs the boolean condition font color for each conditional format rule on a
// sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const color = rule.getBooleanCondition().getFontColorObject();
  Logger.log(`Font color: ${color.asRgbColor().asHexString()}`);
}

戻る

Color - フォント色。この条件に設定されていない場合は null です。

getItalic()

このブール値の条件でテキストが斜体化される場合は true を返し、このブール値の条件でテキストから斜体化が削除される場合は false を返します。斜体に影響がない場合、null を返します。

// Logs the boolean condition font style for each conditional format rule on a
// sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const italic = rule.getBooleanCondition().getItalic();
  Logger.log(`Italic: ${italic}`);
}

戻る

Boolean - ブール値の条件でテキストを斜体にするかどうか。斜体にしない場合は null です。

getStrikethrough()

このブール条件でテキストに取り消し線が引かれる場合は true を返し、このブール条件でテキストから取り消し線が削除される場合は false を返します。取り消し線が影響を受けない場合は null を返します。

// Logs the boolean condition strikethrough setting for each conditional format
// rule on a sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const strikethrough = rule.getBooleanCondition().getStrikethrough();
  Logger.log(`Strikethrough: ${strikethrough}`);
}

戻る

Boolean - ブール値の条件がテキストを取り消し線を引くかどうか。取り消し線が影響しない場合は null です。

getUnderline()

このブール条件でテキストの下線が引かれる場合は true を返し、このブール条件でテキストの下線が削除される場合は false を返します。下線が影響を受けない場合は null を返します。

// Logs the boolean condition underline setting for each conditional format rule
// on a sheet.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
for (const rule of rules) {
  const underline = rule.getBooleanCondition().getUnderline();
  Logger.log(`Underline: ${underline}`);
}

戻る

Boolean - ブール値の条件でテキストに下線を引くかどうか。下線を引かない場合は null です。

サポート終了のメソッド