Class DataValidation  |  Apps Script  |  Google for Developers (original) (raw)

Class DataValidation

Stay organized with collections Save and categorize content based on your preferences.

DataValidation

Access data validation rules. To create a new rule, use [SpreadsheetApp.newDataValidation()](/apps-script/reference/spreadsheet/spreadsheet-app#newDataValidation%28%29) and [DataValidationBuilder](/apps-script/reference/spreadsheet/data-validation-builder). You can use[Range.setDataValidation(rule)](/apps-script/reference/spreadsheet/range#setDataValidation%28DataValidation%29) to set the validation rule for a range.

// Log information about the data validation rule for cell A1. const cell = SpreadsheetApp.getActive().getRange('A1'); const rule = cell.getDataValidation(); if (rule != null) { const criteria = rule.getCriteriaType(); const 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.'); }

Methods

Detailed documentation

copy()

Creates a builder for a data validation rule based on this rule's settings.

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

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

if (rule != null) {
  const criteria = rule.getCriteriaType();
  const 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);

Return

[DataValidationBuilder](/apps-script/reference/spreadsheet/data-validation-builder) — a builder based on this rule's settings

getAllowInvalid()

Returns true if the rule shows a warning when input fails data validation, or false if it rejects the input entirely. The default for new data validation rules is true.

Return

Boolean — true if the rule allows input that fails data validation; false if not

getCriteriaType()

Gets the rule's criteria type as defined in the [DataValidationCriteria](/apps-script/reference/spreadsheet/data-validation-criteria) enum. To get the arguments for the criteria, use [getCriteriaValues()](#getCriteriaValues%28%29). To use these values to create or modify a data validation rule, see [DataValidationBuilder.withCriteria(criteria, args)](/apps-script/reference/spreadsheet/data-validation-builder#withCriteria%28DataValidationCriteria,Object%29).

// Log information about the data validation rule for cell A1. const cell = SpreadsheetApp.getActive().getRange('A1'); const rule = cell.getDataValidation(); if (rule != null) { const criteria = rule.getCriteriaType(); const 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.'); }

Return

[DataValidationCriteria](/apps-script/reference/spreadsheet/data-validation-criteria) — the type of data validation criteria

getCriteriaValues()

Gets an array of arguments for the rule's criteria. To get the criteria type, use [getCriteriaType()](#getCriteriaType%28%29). To use these values to create or modify a data validation rule, see [DataValidationBuilder.withCriteria(criteria, args)](/apps-script/reference/spreadsheet/data-validation-builder#withCriteria%28DataValidationCriteria,Object%29).

// Log information about the data validation rule for cell A1. const cell = SpreadsheetApp.getActive().getRange('A1'); const rule = cell.getDataValidation(); if (rule != null) { const criteria = rule.getCriteriaType(); const 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.'); }

Return

Object[] — an array of arguments appropriate to the rule's criteria type; the number of arguments and their type match the corresponding require...() method of the [DataValidationBuilder](/apps-script/reference/spreadsheet/data-validation-builder) class

getHelpText()

Gets the rule's help text, or null if no help text is set.

Return

String — the rule's help text, or null if no help text is set

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-12-03 UTC.