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

已淘汰的方法