Class DataValidationBuilder

DataValidationBuilder

Compilateur pour les règles de validation des données.

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

Méthodes

MéthodeType renvoyéBrève description
build()DataValidationConstruit une règle de validation des données à partir des paramètres appliqués au compilateur.
copy()DataValidationBuilderCrée un compilateur pour une règle de validation des données basée sur les paramètres de cette règle.
getAllowInvalid()BooleanRenvoie true si la règle affiche un avertissement lorsque la validation des données échoue, ou false si elle rejette complètement l'entrée.
getCriteriaType()DataValidationCriteriaRécupère le type de critère de la règle tel que défini dans l'énumération DataValidationCriteria.
getCriteriaValues()Object[]Récupère un tableau d'arguments correspondant aux critères de la règle.
getHelpText()StringRécupère le texte d'aide de la règle ou null si aucun texte d'aide n'est défini.
requireCheckbox()DataValidationBuilderDéfinit la règle de validation des données pour exiger que l'entrée soit une valeur booléenne. Cette valeur est affichée sous la forme d'une case à cocher.
requireCheckbox(checkedValue)DataValidationBuilderDéfinit la règle de validation des données de sorte que la valeur saisie soit la valeur spécifiée ou vide.
requireCheckbox(checkedValue, uncheckedValue)DataValidationBuilderDéfinit la règle de validation des données de manière à exiger que l'entrée soit l'une des valeurs spécifiées.
requireDate()DataValidationBuilderDéfinit la règle de validation des données de manière à exiger une date.
requireDateAfter(date)DataValidationBuilderDéfinit la règle de validation des données de manière à exiger une date postérieure à la valeur donnée.
requireDateBefore(date)DataValidationBuilderDéfinit la règle de validation des données de manière à exiger une date antérieure à la valeur donnée.
requireDateBetween(start, end)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige une date située entre deux dates spécifiées ou l'une d'entre elles.
requireDateEqualTo(date)DataValidationBuilderDéfinit la règle de validation des données de manière à exiger une date égale à la valeur donnée.
requireDateNotBetween(start, end)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige une date qui ne se situe pas entre deux dates spécifiées, mais qui ne correspond à aucune des deux.
requireDateOnOrAfter(date)DataValidationBuilderDéfinit la règle de validation des données de manière à exiger une date identique ou postérieure à la valeur donnée.
requireDateOnOrBefore(date)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige une date identique ou antérieure à la valeur donnée.
requireFormulaSatisfied(formula)DataValidationBuilderDéfinit la règle de validation des données de sorte que la formule donnée renvoie la valeur true.
requireNumberBetween(start, end)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige un nombre compris entre deux nombres spécifiés ou l'un d'entre eux.
requireNumberEqualTo(number)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige un nombre égal à la valeur donnée.
requireNumberGreaterThan(number)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige un nombre supérieur à la valeur donnée.
requireNumberGreaterThanOrEqualTo(number)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige un nombre supérieur ou égal à la valeur donnée.
requireNumberLessThan(number)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige un nombre inférieur à la valeur donnée.
requireNumberLessThanOrEqualTo(number)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige un nombre inférieur ou égal à la valeur donnée.
requireNumberNotBetween(start, end)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige un nombre qui ne se trouve pas entre deux nombres spécifiés, ou qui ne se trouve pas dans l'un d'entre eux.
requireNumberNotEqualTo(number)DataValidationBuilderDéfinit la règle de validation des données de sorte qu'elle exige un nombre différent de la valeur donnée.
requireTextContains(text)DataValidationBuilderDéfinit la règle de validation des données de sorte que l'entrée contienne la valeur donnée.
requireTextDoesNotContain(text)DataValidationBuilderDéfinit la règle de validation des données de sorte que l'entrée ne contienne pas la valeur donnée.
requireTextEqualTo(text)DataValidationBuilderDéfinit la règle de validation des données de sorte que l'entrée soit égale à la valeur donnée.
requireTextIsEmail()DataValidationBuilderDéfinit la règle de validation des données de sorte que les données saisies se présentent sous la forme d'une adresse e-mail.
requireTextIsUrl()DataValidationBuilderDéfinit la règle de validation des données de sorte que l'entrée se présente sous la forme d'une URL.
requireValueInList(values)DataValidationBuilderDéfinit la règle de validation des données de sorte que l'entrée soit égale à l'une des valeurs données.
requireValueInList(values, showDropdown)DataValidationBuilderDéfinit la règle de validation des données de sorte que l'entrée soit égale à l'une des valeurs données, avec la possibilité de masquer le menu déroulant.
requireValueInRange(range)DataValidationBuilderDéfinit la règle de validation des données de sorte que l'entrée soit égale à une valeur comprise dans la plage donnée.
requireValueInRange(range, showDropdown)DataValidationBuilderDéfinit la règle de validation des données de sorte que l'entrée soit égale à une valeur de la plage donnée, avec la possibilité de masquer le menu déroulant.
setAllowInvalid(allowInvalidData)DataValidationBuilderDétermine si un avertissement doit s'afficher lorsque la validation des données de l'entrée échoue ou si celle-ci doit être entièrement rejetée.
setHelpText(helpText)DataValidationBuilderDéfinit le texte d'aide qui s'affiche lorsque l'utilisateur pointe sur la cellule sur laquelle la validation des données est définie.
withCriteria(criteria, args)DataValidationBuilderIl définit la règle de validation des données sur des critères définis par des valeurs DataValidationCriteria, généralement extraites des paramètres criteria et arguments d'une règle existante.

Documentation détaillée

build()

Construit une règle de validation des données à partir des paramètres appliqués au compilateur.

Renvois

DataValidation : représentation de la règle de validation des données


copy()

Crée un compilateur pour une règle de validation des données basée sur les paramètres de cette règle.

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

Renvois

DataValidationBuilder : outil de création basé sur les paramètres de cette règle


getAllowInvalid()

Renvoie true si la règle affiche un avertissement lorsque la validation des données échoue, ou false si elle rejette complètement l'entrée. La valeur par défaut pour les nouvelles règles de validation des données est true.

Renvois

Boolean : true si la règle autorise une entrée dont la validation des données échoue ; false dans le cas contraire.


getCriteriaType()

Récupère le type de critère de la règle tel que défini dans l'énumération DataValidationCriteria. Pour obtenir les arguments des critères, utilisez getCriteriaValues(). Si vous souhaitez utiliser ces valeurs pour créer ou modifier une règle de validation des données, consultez 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.')
}

Renvois

DataValidationCriteria : type de critère de validation des données


getCriteriaValues()

Récupère un tableau d'arguments correspondant aux critères de la règle. Pour obtenir le type de critère, utilisez getCriteriaType(). Pour créer ou modifier une règle de validation des données à l'aide de ces valeurs, consultez 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.')
}

Renvois

Object[] : tableau d'arguments adapté au type de critère de la règle. Le nombre d'arguments et leur type correspondent à la méthode require...() correspondante de la classe DataValidationBuilder.


getHelpText()

Récupère le texte d'aide de la règle ou null si aucun texte d'aide n'est défini.

Renvois

String : texte d'aide de la règle ou null si aucun texte d'aide n'est défini


requireCheckbox()

Définit la règle de validation des données pour exiger que l'entrée soit une valeur booléenne. Cette valeur est affichée sous la forme d'une case à cocher.

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

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireCheckbox(checkedValue)

Définit la règle de validation des données de sorte que la valeur saisie soit la valeur spécifiée ou vide. Lorsque l'entrée correspond à la valeur spécifiée, la cellule s'affiche sous la forme d'une case à cocher cochée. Lorsque l'entrée est vide, la cellule s'affiche en tant que case décochée.

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

Paramètres

NomTypeDescription
checkedValueObjectValeur attribuée à une case cochée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireCheckbox(checkedValue, uncheckedValue)

Définit la règle de validation des données de manière à exiger que l'entrée soit l'une des valeurs spécifiées. Lorsque l'entrée est checkedValue, la cellule est affichée sous la forme d'une case cochée. Lorsque l'entrée est uncheckedValue, la cellule s'affiche en tant que case décochée.

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

Paramètres

NomTypeDescription
checkedValueObjectValeur attribuée à une case cochée.
uncheckedValueObjectValeur attribuée à une case décochée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDate()

Définit la règle de validation des données de manière à exiger une date.

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

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateAfter(date)

Définit la règle de validation des données de manière à exiger une date postérieure à la valeur donnée. Les champs de date et d'heure de l'objet Date sont ignorés. Seuls les champs de jour, de mois et d'année sont utilisés.

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

Paramètres

NomTypeDescription
dateDateDernière date non autorisée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateBefore(date)

Définit la règle de validation des données de manière à exiger une date antérieure à la valeur donnée. Les champs de date et d'heure de l'objet Date sont ignorés. Seuls les champs de jour, de mois et d'année sont utilisés.

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

Paramètres

NomTypeDescription
dateDatePremière date non autorisée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateBetween(start, end)

Définit la règle de validation des données de sorte qu'elle exige une date située entre deux dates spécifiées ou l'une d'entre elles. Les champs temporels des objets Date sont ignorés. Seuls les champs de jour, de mois et d'année sont utilisés.

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

Paramètres

NomTypeDescription
startDateDate la plus proche autorisée.
endDateDernière date acceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateEqualTo(date)

Définit la règle de validation des données de manière à exiger une date égale à la valeur donnée. Les champs temporels de l'objet Date sont ignorés. Seuls les champs de jour, de mois et d'année sont utilisés.

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

Paramètres

NomTypeDescription
dateDateSeule date acceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateNotBetween(start, end)

Définit la règle de validation des données de sorte qu'elle exige une date qui ne se situe pas entre deux dates spécifiées, mais qui ne correspond à aucune des deux. Les champs temporels des objets Date sont ignorés. Seuls les champs de jour, de mois et d'année sont utilisés.

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

Paramètres

NomTypeDescription
startDatePremière date non autorisée.
endDateDernière date non autorisée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateOnOrAfter(date)

Définit la règle de validation des données de manière à exiger une date identique ou postérieure à la valeur donnée. Les champs temporels de l'objet Date sont ignorés. Seuls les champs de jour, de mois et d'année sont utilisés.

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

Paramètres

NomTypeDescription
dateDateDate la plus proche autorisée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateOnOrBefore(date)

Définit la règle de validation des données de sorte qu'elle exige une date identique ou antérieure à la valeur donnée. Les champs temporels de l'objet Date sont ignorés. Seuls les champs de jour, de mois et d'année sont utilisés.

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

Paramètres

NomTypeDescription
dateDateDernière date acceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireFormulaSatisfied(formula)

Définit la règle de validation des données de sorte que la formule donnée renvoie la valeur 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);

Paramètres

NomTypeDescription
formulaStringFormule personnalisée qui renvoie la valeur true si l'entrée est valide.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberBetween(start, end)

Définit la règle de validation des données de sorte qu'elle exige un nombre compris entre deux nombres spécifiés ou l'un d'entre eux.

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

Paramètres

NomTypeDescription
startNumberValeur acceptable la plus basse.
endNumberValeur acceptable la plus élevée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberEqualTo(number)

Définit la règle de validation des données de sorte qu'elle exige un nombre égal à la valeur donnée.

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

Paramètres

NomTypeDescription
numberNumberSeule valeur acceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberGreaterThan(number)

Définit la règle de validation des données de sorte qu'elle exige un nombre supérieur à la valeur donnée.

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

Paramètres

NomTypeDescription
numberNumberValeur inacceptable la plus élevée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberGreaterThanOrEqualTo(number)

Définit la règle de validation des données de sorte qu'elle exige un nombre supérieur ou égal à la valeur donnée.

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

Paramètres

NomTypeDescription
numberNumberValeur acceptable la plus basse.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberLessThan(number)

Définit la règle de validation des données de sorte qu'elle exige un nombre inférieur à la valeur donnée.

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

Paramètres

NomTypeDescription
numberNumberValeur la plus basse inacceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberLessThanOrEqualTo(number)

Définit la règle de validation des données de sorte qu'elle exige un nombre inférieur ou égal à la valeur donnée.

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

Paramètres

NomTypeDescription
numberNumberValeur acceptable la plus élevée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberNotBetween(start, end)

Définit la règle de validation des données de sorte qu'elle exige un nombre qui ne se trouve pas entre deux nombres spécifiés, ou qui ne se trouve pas dans l'un d'entre eux.

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

Paramètres

NomTypeDescription
startNumberValeur la plus basse inacceptable.
endNumberValeur inacceptable la plus élevée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberNotEqualTo(number)

Définit la règle de validation des données de sorte qu'elle exige un nombre différent de la valeur donnée.

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

Paramètres

NomTypeDescription
numberNumberSeule valeur non autorisée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireTextContains(text)

Définit la règle de validation des données de sorte que l'entrée contienne la valeur donnée.

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

Paramètres

NomTypeDescription
textStringValeur que l'entrée doit contenir.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireTextDoesNotContain(text)

Définit la règle de validation des données de sorte que l'entrée ne contienne pas la valeur donnée.

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

Paramètres

NomTypeDescription
textStringValeur que l'entrée ne doit pas contenir.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireTextEqualTo(text)

Définit la règle de validation des données de sorte que l'entrée soit égale à la valeur donnée.

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

Paramètres

NomTypeDescription
textStringSeule valeur acceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireTextIsEmail()

Définit la règle de validation des données de sorte que les données saisies se présentent sous la forme d'une adresse 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);

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireTextIsUrl()

Définit la règle de validation des données de sorte que l'entrée se présente sous la forme d'une 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);

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireValueInList(values)

Définit la règle de validation des données de sorte que l'entrée soit égale à l'une des valeurs données.

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

Paramètres

NomTypeDescription
valuesString[]Tableau de valeurs acceptables.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireValueInList(values, showDropdown)

Définit la règle de validation des données de sorte que l'entrée soit égale à l'une des valeurs données, avec la possibilité de masquer le menu déroulant.

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

Paramètres

NomTypeDescription
valuesString[]Tableau de valeurs acceptables.
showDropdownBooleantrue si la feuille de calcul doit afficher un menu déroulant pour les valeurs ; false dans le cas contraire.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireValueInRange(range)

Définit la règle de validation des données de sorte que l'entrée soit égale à une valeur comprise dans la plage donnée.

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

Paramètres

NomTypeDescription
rangeRangePlage contenant les valeurs acceptables.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireValueInRange(range, showDropdown)

Définit la règle de validation des données de sorte que l'entrée soit égale à une valeur de la plage donnée, avec la possibilité de masquer le menu déroulant.

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

Paramètres

NomTypeDescription
rangeRangePlage contenant les valeurs acceptables.
showDropdownBooleantrue si la feuille de calcul doit afficher un menu déroulant pour les valeurs ; false dans le cas contraire.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


setAllowInvalid(allowInvalidData)

Détermine si un avertissement doit s'afficher lorsque la validation des données de l'entrée échoue ou si celle-ci doit être entièrement rejetée. La valeur par défaut pour les nouvelles règles de validation des données est true.

Paramètres

NomTypeDescription
allowInvalidDataBooleantrue si la règle doit autoriser les entrées qui échouent à la validation des données ; false dans le cas contraire.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


setHelpText(helpText)

Définit le texte d'aide qui s'affiche lorsque l'utilisateur pointe sur la cellule sur laquelle la validation des données est définie.

Paramètres

NomTypeDescription
helpTextStringTexte d'aide à définir.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


withCriteria(criteria, args)

Il définit la règle de validation des données sur des critères définis par des valeurs DataValidationCriteria, généralement extraites des paramètres criteria et arguments d'une règle existante.

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

Paramètres

NomTypeDescription
criteriaDataValidationCriteriaLe type de critère de validation des données.
argsObject[]Tableau d'arguments adapté au type de critère. Le nombre d'arguments et leur type correspondent à la méthode require...() correspondante ci-dessus.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage