Class BooleanCondition

BooleanCondition

Acesse condições booleanas em ConditionalFormatRules. Cada regra de formatação condicional pode conter uma única condição booleana. A condição booleana em si contém um critério booleano (com valores) e configurações de formatação. O critério é avaliado em relação ao conteúdo de uma célula, resultando em um valor true ou false. Se os critérios forem avaliados como true, as configurações de formatação da condição serão aplicadas à célula.

Métodos

MétodoTipo de retornoBreve descrição
getBackgroundObject()Color|nullRecebe a cor de segundo plano para essa condição booleana.
getBold()Boolean|nullRetorna true se essa condição booleana colocar o texto em negrito e false se ela remover o negrito do texto.
getCriteriaType()BooleanCriteriaRecebe o tipo de critério da regra, conforme definido na enumeração BooleanCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getFontColorObject()Color|nullRecebe a cor da fonte para essa condição booleana.
getItalic()Boolean|nullRetorna true se essa condição booleana colocar o texto em itálico e false se ela remover o itálico do texto.
getStrikethrough()Boolean|nullRetorna true se essa condição booleana riscar o texto e false se ela remover o risco do texto.
getUnderline()Boolean|nullRetorna true se essa condição booleana sublinhar o texto e false se ela remover o sublinhado.

Documentação detalhada

getBackgroundObject()

Recebe a cor de segundo plano para essa condição booleana. Retorna null se não estiver definido. 

// 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()}`);
}

Retornar

Color|null: a cor de plano de fundo ou null se não estiver definida para essa condição.

getBold()

Retorna true se essa condição booleana colocar o texto em negrito e false se ela remover o negrito do texto. Retorna null se o negrito não for afetado. 

// 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}`);
}

Retornar

Boolean|null: se a condição booleana coloca o texto em negrito ou null se o negrito não é afetado.

getCriteriaType()

Recebe o tipo de critério da regra, conforme definido na enumeração BooleanCriteria. Para receber os argumentos dos critérios, use getCriteriaValues(). Para usar esses valores e criar ou modificar uma regra de formatação condicional, consulte 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}`);
  }
});

Retornar

BooleanCriteria: o tipo de critério de formatação condicional.

getCriteriaValues()

Recebe uma matriz de argumentos para os critérios da regra. Para receber o tipo de critério, use getCriteriaType(). Para usar esses valores e criar ou modificar uma regra de formatação condicional, consulte 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}`);
  }
});

Retornar

Object[]: uma matriz de argumentos adequada ao tipo de critério da regra. O número de argumentos e o tipo deles correspondem ao método when...() correspondente da classe ConditionalFormatRuleBuilder.

getFontColorObject()

Recebe a cor da fonte para essa condição booleana. Retorna null se não estiver definido. 

// 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()}`);
}

Retornar

Color|null: a cor da fonte ou null se não estiver definida para essa condição.

getItalic()

Retorna true se essa condição booleana colocar o texto em itálico e false se ela remover o itálico do texto. Retorna null se o itálico não for afetado. 

// 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}`);
}

Retornar

Boolean|null: se a condição booleana coloca o texto em itálico ou null se a ação de colocar em itálico não é afetada

getStrikethrough()

Retorna true se essa condição booleana riscar o texto e false se ela remover o risco do texto. Retorna null se o tachado não for afetado. 

// 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}`);
}

Retornar

Boolean|null: se a condição booleana risca o texto ou null se o riscado não for afetado.

getUnderline()

Retorna true se essa condição booleana sublinhar o texto e false se ela remover o sublinhado. Retorna null se o sublinhado não for afetado. 

// 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}`);
}

Retornar

Boolean|null: se a condição booleana sublinha o texto ou null se o sublinhado não é afetado

Métodos obsoletos