Class DataValidationBuilder

Cria uma regra de validação de dados com base nas configurações aplicadas ao builder.

Retornar

DataValidation: uma representação da regra de validação de dados.

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

// 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 com base nas configurações desta regra.

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

Retornar

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

Recebe o tipo de critério da regra, conforme definido no tipo enumerado DataValidationCriteria. Para conseguir argumentos de venda para os critérios, use getCriteriaValues(). Para usar esses valores para criar ou modificar uma regra de validação de dados, consulte 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 de dados.

Recebe uma matriz de argumentos para os critérios da regra. Para ver o tipo de critério, use getCriteriaType(). Se quiser usar esses valores para criar ou modificar uma regra de validação de dados, consulte 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ério da regra. o número de argumentos e o tipo deles corresponde ao método require...() da classe DataValidationBuilder.

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.

Define a regra de validação de dados para exigir que a entrada seja um valor booleano; esse valor é renderizados como uma caixa de seleção.

// Set the data validation for cell A1 to require a boolean value; the value is rendered as a
// checkbox.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireCheckbox().build();
cell.setDataValidation(rule);

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a entrada tenha o valor especificado ou esteja em branco. Quando a entrada corresponder ao valor especificado e a célula for renderizada como uma caixa de seleção marcada. Quando o a entrada está em branco, a célula é renderizada como uma caixa de seleção desmarcada.

// Set the data validation for cell A1 to require a custom checked value that is rendered as a
// checkbox.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireCheckbox('APPROVED').build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a entrada seja um dos valores especificados. Quando a entrada for checkedValue, a célula será renderizada como uma caixa de seleção marcada. Quando o a entrada é uncheckedValue, a célula é renderizada como uma caixa de seleção desmarcada.

// Set the data validation for cell A1 to require custom checked values that are rendered as a
// checkbox.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireCheckbox('APPROVED', 'PENDING').build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir uma data.

// Set the data validation for cell A1 to require a date.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireDate().build();
cell.setDataValidation(rule);

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir uma data posterior ao valor fornecido. Os campos de hora do Date serão ignorados. apenas os campos dia, mês e ano são usados.

// Set the data validation for cell A1 to require a date after January 1, 2013.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireDateAfter(new Date('1/1/2013')).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir uma data anterior ao valor fornecido. Os campos de hora do Date serão ignorados. apenas os campos dia, mês e ano são usados.

// Set the data validation for cell A1 to require a date before January 1, 2013.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireDateBefore(new Date('1/1/2013')).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir uma data entre duas ou seja uma delas as datas especificadas. Os campos de horário dos objetos Date são ignorados. apenas o dia, o mês, e ano são usados.

// Set the data validation for cell A1 to require a date in 2013.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireDateBetween(new Date('1/1/2013'), new Date('12/31/2013')).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir uma data igual ao valor informado. Os campos de hora os objetos Date são ignorados. apenas os campos dia, mês e ano são usados.

// Set the data validation for cell A1 to require a date equal to January 1, 2013.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireDateEqualTo(new Date('1/1/2013'))
    .build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir uma data que não esteja entre e não esteja entre duas datas especificadas. Os campos de horário dos objetos Date são ignorados. apenas o dia, os campos mês e ano são usados.

// Set the data validation for cell A1 to require a date not in 2013.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireDateNotBetween(new Date('1/1/2013'), new Date('12/31/2013')).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir uma data igual ou posterior ao valor fornecido. Os campos de hora os objetos Date são ignorados. apenas os campos dia, mês e ano são usados.

// Set the data validation for cell A1 to require a date on or after January 1, 2013.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireDateOnOrAfter(new Date('1/1/2013')).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir uma data igual ou anterior ao valor fornecido. Os campos de hora do objeto Date são ignorados. apenas os campos dia, mês e ano são usados.

// Set the data validation for cell A1 to require a date on or before January 1, 2013.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireDateOnOrBefore(new Date('1/1/2013')).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a fórmula fornecida seja avaliada como true.

// Set the data validation for cell A1 to equal B1 with a custom formula.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireFormulaSatisfied('=EQ(A1,B1)').build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir um número que esteja entre dois ou seja um deles números especificados.

// Set the data validation for cell A1 to require a number between 1 and 10.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireNumberBetween(1, 10).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir um número igual ao valor fornecido.

// Set the data validation for cell A1 to require a number equal to 3.1415926536.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireNumberEqualTo(3.1415926536).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir um número maior que o valor fornecido.

// Set the data validation for cell A1 to require a number greater than 0.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireNumberGreaterThan(0).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir um número maior ou igual ao valor fornecido.

// Set the data validation for cell A1 to require a number greater than or equal to 0.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireNumberGreaterThanOrEqualTo(0).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir um número menor que o valor fornecido.

// Set the data validation for cell A1 to require a number less than 0.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireNumberLessThan(0).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir um número menor ou igual ao valor fornecido.

// Set the data validation for cell A1 to require a number less than or equal to 0.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireNumberLessThanOrEqualTo(0).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir um número que não esteja entre e não é dois números especificados.

// Set the data validation for cell A1 to require a number not between 1 and 10.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireNumberNotBetween(1, 10).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir um número diferente do valor informado.

// Set the data validation for cell A1 to require a number not equal to 0.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireNumberNotEqualTo(0).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a entrada contenha o valor fornecido.

// Set the data validation for cell A1 to require any value that includes "Google".
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireTextContains('Google').build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a entrada não contenha o valor fornecido.

// Set the data validation for cell A1 to require any value that does not include "@".
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireTextDoesNotContain('@').build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a entrada seja igual ao valor fornecido.

// Set the data validation for cell A1 to require "Yes".
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireTextEqualTo('Yes').build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a entrada esteja na forma de um endereço de e-mail.

// Set the data validation for cell A1 to require text in the form of an email address.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireTextIsEmail().build();
cell.setDataValidation(rule);

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a entrada esteja no formato de um URL.

// Set the data validation for cell A1 to require text in the form of a URL.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireTextIsUrl().build();
cell.setDataValidation(rule);

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a entrada seja igual a um dos valores fornecidos.

// Set the data validation for cell A1 to require "Yes" or "No", with a dropdown menu.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireValueInList(['Yes', 'No']).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

define a regra de validação de dados para exigir que a entrada seja igual a um dos valores fornecidos; com uma opção para ocultar o menu suspenso.

// Set the data validation for cell A1 to require "Yes" or "No", with no dropdown menu.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation().requireValueInList(['Yes', 'No'], false).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a entrada seja igual a um valor no intervalo especificado.

// Set the data validation for cell A1 to require a value from B1:B10, with a dropdown menu.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados para exigir que a entrada seja igual a um valor no intervalo especificado. com uma opção para ocultar o menu suspenso.

// Set the data validation for cell A1 to require value from B1:B10, with no dropdown menu.
var cell = SpreadsheetApp.getActive().getRange('A1');
var range = SpreadsheetApp.getActive().getRange('B1:B10');
var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range, false).build();
cell.setDataValidation(rule);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define se um aviso será mostrado quando a entrada falhar na validação de dados ou se a entrada será rejeitada completamente. O padrão para novas regras de validação de dados é true.

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define o texto de ajuda que aparece quando o usuário passa o mouse sobre a célula na qual a validação de dados está definido.

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento

Define a regra de validação de dados como critérios definidos por valores DataValidationCriteria. normalmente retirados do criteria e do arguments de uma regra existente.

// 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);

Parâmetros

Retornar

DataValidationBuilder: este builder para encadeamento