Class ConditionalFormatRule

ConditionalFormatRule

Acessar regras de formatação condicional. Para criar uma nova regra, use SpreadsheetApp.newConditionalFormatRule() e ConditionalFormatRuleBuilder. Use Sheet.setConditionalFormatRules(rules) para definir regras para uma determinada página.

Métodos

MétodoTipo de retornoBreve descrição
copy()ConditionalFormatRuleBuilderRetorna uma predefinição do criador de regras com as configurações dessa regra.
getBooleanCondition()BooleanConditionRecupera as informações do BooleanCondition da regra se esta regra usar critérios de condição booleana.
getGradientCondition()GradientConditionRecupera as informações do GradientCondition da regra, se essa regra usa critérios de condição de gradiente.
getRanges()Range[]Recupera os intervalos aos quais esta regra de formatação condicional é aplicada.

Documentação detalhada

copy()

Retorna uma predefinição do criador de regras com as configurações dessa regra.

Retornar

ConditionalFormatRuleBuilder: um builder com base nas configurações desta regra.

getBooleanCondition()

Recupera as informações do BooleanCondition da regra se esta regra usar critérios de condição booleana. Caso contrário, retorna null. 

// Log the boolean criteria type of the first conditional format rules of a sheet.
var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
var booleanCondition = rule.getBooleanCondition();
if (booleanCondition != null) {
  Logger.log(booleanCondition.getCriteriaType());
}

Retornar

BooleanCondition: o objeto de condição booleano, ou null se a regra não usar um booleano condição.

getGradientCondition()

Recupera as informações do GradientCondition da regra, se essa regra usa critérios de condição de gradiente. Caso contrário, retorna null. 

// Log the gradient minimum color of the first conditional format rule of a sheet.
var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
var gradientCondition = rule.getGradientCondition();
if (gradientCondition != null) {
  // Assume the color has ColorType.RGB.
  Logger.log(gradientCondition.getMinColorObject().asRgbColor().asHexString());
}

Retornar

GradientCondition: o objeto da condição de gradiente, ou null se a regra não usar um gradiente condição.

getRanges()

Recupera os intervalos aos quais esta regra de formatação condicional é aplicada. 

// Log each range of the first conditional format rule of a sheet.
var rule = SpreadsheetApp.getActiveSheet().getConditionalFormatRules()[0];
var ranges = rule.getRanges();
for (var i = 0; i < ranges.length; i++) {
  Logger.log(ranges[i].getA1Notation());
}

Retornar

Range[]: os intervalos aos quais essa regra de formato condicional é aplicada.