Class DataValidation

DataValidation

Auf Datenvalidierungsregeln zugreifen. Verwenden Sie SpreadsheetApp.newDataValidation() und DataValidationBuilder, um eine neue Regel zu erstellen. Sie können Range.setDataValidation(rule), um die Validierungsregel für einen Bereich festzulegen.

// 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.')
}

Methoden

MethodeRückgabetypKurzbeschreibung
copy()DataValidationBuilderErstellt einen Builder für eine Datenvalidierungsregel anhand der Einstellungen dieser Regel.
getAllowInvalid()BooleanGibt true zurück, wenn die Regel eine Warnung anzeigt, wenn bei der Eingabe die Datenvalidierung fehlschlägt, oder false, wenn die Eingabe vollständig abgelehnt wird.
getCriteriaType()DataValidationCriteriaRuft den Kriterientyp der Regel gemäß der Definition in der DataValidationCriteria-Enum ab.
getCriteriaValues()Object[]Ruft ein Array von Argumenten für die Kriterien der Regel ab.
getHelpText()StringRuft den Hilfetext der Regel ab oder null, wenn kein Hilfetext festgelegt ist.

Detaillierte Dokumentation

copy()

Erstellt einen Builder für eine Datenvalidierungsregel anhand der Einstellungen dieser Regel.

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

Rückflug

DataValidationBuilder: Ein Builder, der auf den Einstellungen dieser Regel basiert


getAllowInvalid()

Gibt true zurück, wenn die Regel eine Warnung anzeigt, wenn bei der Eingabe die Datenvalidierung fehlschlägt, oder false, wenn die Eingabe vollständig abgelehnt wird. Die Standardeinstellung für neue Datenvalidierungsregeln ist true.

Rückflug

Boolean: true, wenn die Regel Eingaben zulässt, die die Datenvalidierung nicht bestehen false wenn nicht


getCriteriaType()

Ruft den Kriterientyp der Regel gemäß der Definition in der DataValidationCriteria-Enum ab. Um die Argumente für die Kriterien, verwenden Sie getCriteriaValues(). Um diese Werte zu verwenden, Datenvalidierungsregel ändern, siehe 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.')
}

Rückflug

DataValidationCriteria – die Art der Datenvalidierungskriterien


getCriteriaValues()

Ruft ein Array von Argumenten für die Kriterien der Regel ab. Verwenden Sie getCriteriaType(), um den Kriterientyp abzurufen. Informationen zum Erstellen oder Ändern einer Datenvalidierungsregel finden Sie unter 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.')
}

Rückflug

Object[]: Ein Array von Argumenten, die dem Kriterientyp der Regel entsprechen. die Anzahl der Argumente und ihr Typ mit der entsprechenden require...()-Methode der DataValidationBuilder-Klasse übereinstimmt


getHelpText()

Ruft den Hilfetext der Regel ab oder null, wenn kein Hilfetext festgelegt ist.

Rückflug

String: der Hilfetext der Regel oder null, wenn kein Hilfetext festgelegt ist