Class DataValidation

DataValidation

Acceder a las reglas de validación de datos Para crear una regla nueva, usa SpreadsheetApp.newDataValidation() y DataValidationBuilder. Puedes usar Range.setDataValidation(rule) para establecer la regla de validación de un rango.

// 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 datos que se muestraDescripción breve
copy()DataValidationBuilderCrea un compilador para una regla de validación de datos según la configuración de esta regla.
getAllowInvalid()BooleanMuestra true si la regla muestra una advertencia cuando la entrada falla en la validación de datos, o false si la rechaza por completo.
getCriteriaType()DataValidationCriteriaObtiene el tipo de criterio de la regla como se define en la enumeración DataValidationCriteria.
getCriteriaValues()Object[]Obtiene un array de argumentos para los criterios de la regla.
getHelpText()StringObtiene el texto de ayuda de la regla o null si no se configuró ningún texto de ayuda.

Documentación detallada

copy()

Crea un compilador para una regla de validación de datos según la configuración de esta regla.

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

Devolvedor

DataValidationBuilder: Es un compilador basado en la configuración de esta regla.


getAllowInvalid()

Muestra true si la regla muestra una advertencia cuando la entrada falla en la validación de datos, o false si la rechaza por completo. El valor predeterminado para las reglas de validación de datos nuevas es true.

Devolvedor

Boolean: true si la regla permite entradas que no pasan la validación de datos; false si no es así.


getCriteriaType()

Obtiene el tipo de criterio de la regla como se define en la enumeración DataValidationCriteria. Para obtener los argumentos de los criterios, usa getCriteriaValues(). Si quieres usar estos valores para crear o modificar una regla de validación de datos, consulta 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.')
}

Devolvedor

DataValidationCriteria: Es el tipo de criterios de validación de datos.


getCriteriaValues()

Obtiene un array de argumentos para los criterios de la regla. Para obtener el tipo de criterio, usa getCriteriaType(). Si quieres usar estos valores para crear o modificar una regla de validación de datos, consulta 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.')
}

Devolvedor

Object[]: Es un array de argumentos apropiado para el tipo de criterio de la regla; la cantidad de argumentos y su tipo coinciden con el método require...() correspondiente de la clase DataValidationBuilder.


getHelpText()

Obtiene el texto de ayuda de la regla o null si no se configuró ningún texto de ayuda.

Devolvedor

String: Es el texto de ayuda de la regla, o bien null si no se configuró un texto de ayuda.