Class BooleanCondition

BooleanCondition

访问 ConditionalFormatRules 中的布尔值条件。每个条件格式规则可以包含一个布尔值条件。布尔条件本身包含布尔条件（含值）和格式设置。系统会根据单元格的相应内容对条件进行评估，并生成 true 或 false 值。如果条件的计算结果为 true，则系统会将条件的格式设置应用于单元格。

方法

方法返回类型简介
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.
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

已弃用的方法