Class BooleanCondition

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
Booleano

Acesse condições booleanas em ConditionalFormatRules. Cada regra de formato condicional pode conter uma única condição booleana. A condição booleana contém um critério booleano (com valores) e configurações de formatação. Os critérios são avaliados 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()ColorRecebe a cor do plano de fundo dessa condição booleana.
getBold()BooleanRetornará true se essa condição booleana remover o negrito do texto e retornará false se a condição booleana remover o negrito do texto.
getCriteriaType()BooleanCriteriaRecebe o tipo de critérios 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 dessa condição booleana.
getItalic()BooleanRetornará true se essa condição booleana remover o itálico do texto e retornará false se a condição booleana remover o itálico do texto.
getStrikethrough()BooleanRetornará true se essa condição booleana remover o tachado do texto e retornará false se a condição booleana remover o tachado do texto.
getUnderline()BooleanRetornará true se essa condição booleana sublinha o texto e retorna false se a condição booleana remover o sublinhado do texto.

Documentação detalhada

getBackgroundObject()

Recebe a cor do plano de fundo dessa condição booleana. Retorna null se não definido.

// Logs the boolean condition background color for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var color = rules[i].getBooleanCondition().getBackgroundObject();
  Logger.log("The background color for rule %s is %s", i, color.asRgbColor().asHexString());
}

Retornar

Color: a cor do plano de fundo, ou null se não for definida para esta condição.


getBold()

Retornará true se essa condição booleana remover o negrito do texto e retornará false se a condição booleana remover o negrito do texto. Retornará null se o efeito negrito não for afetado.

// Logs the boolean condition font weight for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var bold = rules[i].getBooleanCondition().getBold();
  Logger.log("The font bold setting for rule %s is %b", i, weight);
}

Retornar

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


getCriteriaType()

Recebe o tipo de critérios da regra conforme definido no tipo enumerado BooleanCriteria. Para acessar os argumentos para os 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.
var sheet = SpreadsheetApp.getActiveSheet;
var formats = sheet.getConditionalFormats();
sheet.getConditionalFormats().forEach(function(format) {
  var booleanCondition = format.getBooleanCondition();
  if (booleanCondition) {
    var criteria = booleanCondition.getCriteriaType();
    var args = booleanCondition.getCriteriaValues();
    Logger.log('The conditional format rule is %s %s', 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 ver 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.
var sheet = SpreadsheetApp.getActiveSheet;
var formats = sheet.getConditionalFormats();
sheet.getConditionalFormats().forEach(function(format) {
  var booleanCondition = format.getBooleanCondition();
  if (booleanCondition) {
    var criteria = booleanCondition.getCriteriaType();
    var args = booleanCondition.getCriteriaValues();
    Logger.log('The conditional format rule is %s %s', criteria, args);
  }
});

Retornar

Object[]: uma matriz de argumentos apropriados para o tipo de critérios 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 dessa condição booleana. Retorna null se não definido.

// Logs the boolean condition font color for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var color = rules[i].getBooleanCondition().getFontColorObject();
  Logger.log("The font color for rule %s is %s", i, color.asRgbColor().asHexString());
}

Retornar

Color: a cor da fonte, ou null se não definida para esta condição.


getItalic()

Retornará true se essa condição booleana remover o itálico do texto e retornará false se a condição booleana remover o itálico do texto. Retornará null se o itálico não for afetado.

// Logs the boolean condition font style for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var italic = rules[i].getBooleanCondition().getItalic();
  Logger.log("The font italic setting for rule %s is %b", i, italic);
}

Retornar

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


getStrikethrough()

Retornará true se essa condição booleana remover o tachado do texto e retornará false se a condição booleana remover o tachado do texto. Retornará null se o tachado não for afetado.

// Logs the boolean condition strikethrough setting for each conditional format rule on a
// sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var strikethrough = rules[i].getBooleanCondition().getStrikethrough();
  Logger.log("The font strikethrough setting for rule %s is %b", i, strikethrough);
}

Retornar

Boolean: se a condição booleana recebe ou não tachado no texto ou null se o tachado não for afetado.


getUnderline()

Retornará true se essa condição booleana sublinha o texto e retorna false se a condição booleana remover o sublinhado do texto. Retorna null se o sublinhado não for afetado.

// Logs the boolean condition underline setting for each conditional format rule on a sheet.
var sheet = SpreadsheetApp.getActiveSheet();
var rules = sheet.getConditionalFormatRules();
for (int i = 0; i < rules.length; i++) {
  var underline = rules[i].getBooleanCondition().getUnderline();
  Logger.log("The font underline setting for rule %s is %b", i, underline);
}

Retornar

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

Métodos obsoletos