Class DataValidation

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

Acessar regras de validação de dados. Para criar uma regra, use SpreadsheetApp.newDataValidation() e DataValidationBuilder. É possível usar Range.setDataValidation(rule) para definir a regra de validação de um intervalo.

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

Métodos

MétodoTipo de retornoBreve descrição
copy()DataValidationBuilderCria um criador para uma regra de validação de dados com base nas configurações desta regra.
getAllowInvalid()BooleanRetornará true se a regra mostrar um aviso quando a entrada falhar na validação de dados ou false se a entrada for totalmente rejeitada.
getCriteriaType()DataValidationCriteriaRecebe o tipo de critérios da regra conforme definido no tipo enumerado DataValidationCriteria.
getCriteriaValues()Object[]Recebe uma matriz de argumentos para os critérios da regra.
getHelpText()StringRecebe o texto de ajuda da regra ou null se nenhum texto de ajuda for definido.

Documentação detalhada

copy()

Cria um criador para uma regra de validação de dados com base nas configurações desta regra.

// Change existing data validation rules that require a date in 2013 to require a date in 2014.
var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
var newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
var sheet = SpreadsheetApp.getActiveSheet();
var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
var rules = range.getDataValidations();

for (var i = 0; i < rules.length; i++) {
  for (var j = 0; j < rules[i].length; j++) {
    var rule = rules[i][j];

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var args = rule.getCriteriaValues();

      if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN
          && args[0].getTime() == oldDates[0].getTime()
          && args[1].getTime() == oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

Retornar

DataValidationBuilder: um builder baseado nas configurações desta regra


getAllowInvalid()

Retornará true se a regra mostrar um aviso quando a entrada falhar na validação de dados ou false se a entrada for totalmente rejeitada. O padrão para novas regras de validação de dados é true.

Retornar

Boolean: true se a regra permitir a entrada que falha na validação de dados. false se não for


getCriteriaType()

Recebe o tipo de critérios da regra conforme definido no tipo enumerado DataValidationCriteria. Para acessar os argumentos para os critérios, use getCriteriaValues(). Para usar esses valores e criar ou modificar uma regra de validação de dados, consulte DataValidationBuilder.withCriteria(criteria, args).

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

Retornar

DataValidationCriteria: o tipo de critérios de validação dos dados


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 validação de dados, consulte DataValidationBuilder.withCriteria(criteria, args).

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.')
}

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 require...() correspondente da classe DataValidation


getHelpText()

Recebe o texto de ajuda da regra ou null se nenhum texto de ajuda for definido.

Retornar

String: o texto de ajuda da regra ou null se nenhum texto de ajuda estiver definido