Class BooleanCondition

BooleanCondition

Acesse condições booleanas em ConditionalFormatRules. Cada regra de formato 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 com base no conteúdo de uma célula, resultando em um valor true ou false. Se o critério for avaliado 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()ColorRecebe a cor de plano de fundo para essa condição booleana.
getBold()BooleanRetorna true se essa condição booleana negritar o texto e false se essa condição booleana remover o negrito do texto.
getCriteriaType()BooleanCriteriaExtrai o tipo de critério da regra, conforme definido no tipo enumerado BooleanCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getFontColorObject()ColorRecebe a cor da fonte para essa condição booleana.
getItalic()BooleanRetorna true se essa condição booleana itálicos o texto e retorna false se essa condição booleana remove itálicos do texto.
getStrikethrough()BooleanRetorna true se essa condição booleana riscar o texto e false se ela remover o tachado do texto.
getUnderline()BooleanRetorna true se essa condição booleana sublinhar o texto e false se essa condição booleana remover o sublinhado do texto.

Documentação detalhada

getBackgroundObject()

Recebe a cor de plano de fundo 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: a cor do plano de fundo ou null se não estiver definido para essa condição.

getBold()

Retorna true se essa condição booleana negritar o texto e false se essa condição booleana 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: indica se a condição booleana negrita o texto ou null se o negrito não afeta o texto.

getCriteriaType()

Extrai o tipo de critério da regra, conforme definido no tipo enumerado BooleanCriteria. Para conferir os argumentos dos critérios, use getCriteriaValues(). Para usar esses valores para 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érios 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 para 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 apropriados para o 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: a cor da fonte ou null se não estiver definida para essa condição.

getItalic()

Retorna true se essa condição booleana itálicos o texto e retorna false se essa condição booleana remove itálicos 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: indica se a condição booleana italiza o texto ou null se a formatação não for afetada.

getStrikethrough()

Retorna true se essa condição booleana riscar o texto e false se ela remover o sublinhado do texto. Retorna null se a 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: indica se a condição booleana risca o texto ou null, se a condição não afeta o texto.

getUnderline()

Retorna true se essa condição booleana sublinhar o texto e false se essa condição booleana remover o sublinhado do texto. Retorna null se a sublinhação não for afetada. 

// 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: indica se a condição booleana sublinhou o texto ou null se a sublinhado não foi afetado.

Métodos obsoletos