Class BooleanCondition

BooleanCondition

Acesse condições booleanas em ConditionalFormatRules. Cada regra de formatação condicional pode conter uma única condição booleana. A própria condição booleana contém critérios booleanos (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 o 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 colocar o texto em negrito e retornar false se essa a condição booleana remove o negrito do texto.
getCriteriaType()BooleanCriteriaRecebe 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 dessa condição booleana.
getItalic()BooleanRetorna true se essa condição booleana coloca o texto em itálico e retorna false se essa condição booleana remove itálico do texto.
getStrikethrough()BooleanRetorna true se essa condição booleana atinge o texto e retorna false se essa condição booleana remove o tachado.
getUnderline()BooleanRetorna true se essa condição booleana sublinha o texto e retorna false se essa condição booleana remove o sublinhado do texto.

Documentação detalhada

getBackgroundObject()

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


getBold()

Retorna true se essa condição booleana coloca o texto em negrito e retorna false se esta a condição booleana remove 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.
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 ou não o texto em negrito, ou null se ele coloca negrito não afetada


getCriteriaType()

Recebe o tipo de critério da regra, conforme definido no tipo enumerado BooleanCriteria. Para conseguir argumentos de venda para os 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.
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 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.
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ério da regra. o número de argumentos e o tipo deles corresponde ao método when...() da classe ConditionalFormatRuleBuilder.


getFontColorObject()

Recebe a cor da fonte dessa condição booleana. Retorna null se não for 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 estiver definido para esta condição.


getItalic()

Retorna true se essa condição booleana coloca o texto em itálico e retorna false se essa condição booleana remove itálico do texto. Retorna null se o itálico for sem ser afetada.

// 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 não, ou null se O itálico não é afetado


getStrikethrough()

Retorna true se essa condição booleana atinge o texto e retorna false se essa condição booleana remove o tachado. Retorna null se o tachado não é 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 envia ou não o texto, ou null se o tachado não é afetado


getUnderline()

Retorna true se essa condição booleana sublinha o texto e retorna false se essa condição booleana remove o sublinhado do texto. Retorna null se estiver sublinhado não é afetada.

// 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: se a condição booleana sublinha ou não o texto, ou null se o sublinhado não é afetado

Métodos obsoletos