Class DataValidationBuilder

DataValidationBuilder

Outil de création de règles de validation des données.

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

Méthodes

MéthodeType renvoyéBrève description
build()DataValidationCrée une règle de validation des données à partir des paramètres appliqués au générateur.
copy()DataValidationBuilderCrée un compilateur pour une règle de validation des données en fonction des paramètres de cette règle.
getAllowInvalid()BooleanRenvoie true si la règle affiche un avertissement lorsque la validation des données d'entrée é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 qu'il est défini dans l'énumération DataValidationCriteria.
getCriteriaValues()Object[]Obtient un tableau d'arguments pour les critères de la règle.
getHelpText()StringRenvoie 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 pour exiger que la saisie soit la valeur spécifiée ou vide.
requireCheckbox(checkedValue, uncheckedValue)DataValidationBuilderDéfinit la règle de validation des données pour exiger que l'entrée soit l'une des valeurs spécifiées.
requireDate()DataValidationBuilderDéfinit la règle de validation des données pour exiger une date.
requireDateAfter(date)DataValidationBuilderDéfinit la règle de validation des données pour exiger une date postérieure à la valeur indiquée.
requireDateBefore(date)DataValidationBuilderDéfinit la règle de validation des données pour exiger une date antérieure à la valeur indiquée.
requireDateBetween(start, end)DataValidationBuilderDéfinit la règle de validation des données pour exiger une date comprise entre deux dates spécifiées ou correspondant à l'une d'elles.
requireDateEqualTo(date)DataValidationBuilderDéfinit la règle de validation des données pour exiger une date égale à la valeur indiquée.
requireDateNotBetween(start, end)DataValidationBuilderDéfinit la règle de validation des données pour exiger une date qui ne se situe pas entre deux dates spécifiées et qui n'est pas l'une d'elles.
requireDateOnOrAfter(date)DataValidationBuilderDéfinit la règle de validation des données pour exiger une date égale ou postérieure à la valeur indiquée.
requireDateOnOrBefore(date)DataValidationBuilderDéfinit la règle de validation des données pour exiger une date égale ou antérieure à la valeur indiquée.
requireFormulaSatisfied(formula)DataValidationBuilderDéfinit la règle de validation des données pour exiger que la formule donnée soit évaluée sur true.
requireNumberBetween(start, end)DataValidationBuilderDéfinit la règle de validation des données pour exiger un nombre compris entre deux nombres spécifiés ou égal à l'un d'eux.
requireNumberEqualTo(number)DataValidationBuilderDéfinit la règle de validation des données pour exiger un nombre égal à la valeur indiquée.
requireNumberGreaterThan(number)DataValidationBuilderDéfinit la règle de validation des données pour exiger un nombre supérieur à la valeur indiquée.
requireNumberGreaterThanOrEqualTo(number)DataValidationBuilderDéfinit la règle de validation des données pour exiger un nombre supérieur ou égal à la valeur indiquée.
requireNumberLessThan(number)DataValidationBuilderDéfinit la règle de validation des données pour exiger un nombre inférieur à la valeur indiquée.
requireNumberLessThanOrEqualTo(number)DataValidationBuilderDéfinit la règle de validation des données pour exiger un nombre inférieur ou égal à la valeur indiquée.
requireNumberNotBetween(start, end)DataValidationBuilderDéfinit la règle de validation des données pour exiger un nombre qui ne se situe pas entre deux nombres spécifiés et qui n'est égal à aucun d'eux.
requireNumberNotEqualTo(number)DataValidationBuilderDéfinit la règle de validation des données pour exiger un nombre différent de la valeur indiquée.
requireTextContains(text)DataValidationBuilderDéfinit la règle de validation des données pour exiger que l'entrée contienne la valeur indiquée.
requireTextDoesNotContain(text)DataValidationBuilderDéfinit la règle de validation des données pour exiger que la saisie ne contienne pas la valeur indiquée.
requireTextEqualTo(text)DataValidationBuilderDéfinit la règle de validation des données pour exiger que la saisie soit égale à la valeur indiquée.
requireTextIsEmail()DataValidationBuilderDéfinit la règle de validation des données pour exiger que l'entrée soit une adresse e-mail.
requireTextIsUrl()DataValidationBuilderDéfinit la règle de validation des données pour exiger que l'entrée soit au format URL.
requireValueInList(values)DataValidationBuilderDéfinit la règle de validation des données pour exiger que la saisie soit égale à l'une des valeurs indiquées.
requireValueInList(values, showDropdown)DataValidationBuilderDéfinit la règle de validation des données pour exiger que la saisie soit égale à l'une des valeurs indiquées, avec la possibilité de masquer le menu déroulant.
requireValueInRange(range)DataValidationBuilderDéfinit la règle de validation des données pour exiger que la saisie soit égale à une valeur de la plage donnée.
requireValueInRange(range, showDropdown)DataValidationBuilderDéfinit la règle de validation des données pour exiger que la saisie soit égale à une valeur dans la plage donnée, avec la possibilité de masquer le menu déroulant.
setAllowInvalid(allowInvalidData)DataValidationBuilderIndique s'il faut afficher un avertissement lorsque la saisie échoue à la validation des données ou s'il faut rejeter complètement la saisie.
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)DataValidationBuilderDéfinit la règle de validation des données sur les critères définis par les valeurs DataValidationCriteria, généralement tirées des criteria et arguments d'une règle existante.

Documentation détaillée

build()

Crée une règle de validation des données à partir des paramètres appliqués au générateur.

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 en fonction des paramètres de cette règle.

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

Renvois

DataValidationBuilder : un compilateur 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 d'entrée é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 les entrées qui ne valident pas les données, false dans le cas contraire


getCriteriaType()

Récupère le type de critère de la règle tel qu'il est défini dans l'énumération DataValidationCriteria. Pour obtenir les arguments des critères, utilisez getCriteriaValues(). Pour utiliser ces valeurs afin de créer ou de modifier une règle de validation des données, consultez withCriteria(criteria, args).

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

Renvois

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


getCriteriaValues()

Obtient un tableau d'arguments pour les critères de la règle. Pour obtenir le type de critère, utilisez getCriteriaType(). Pour utiliser ces valeurs afin de créer ou de modifier une règle de validation des données, consultez withCriteria(criteria, args).

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

Renvois

Object[] : tableau d'arguments adaptés 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()

Renvoie 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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger que la saisie soit la valeur spécifiée ou vide. Lorsque l'entrée correspond à la valeur spécifiée, la cellule est affichée sous la forme d'une case à cocher cochée. Lorsque l'entrée est vide, la cellule est affichée sous la forme d'une case à cocher non cochée.

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

Paramètres

NomTypeDescription
checkedValueObjectValeur attribuée à une case à cocher.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireCheckbox(checkedValue, uncheckedValue)

Définit la règle de validation des données pour 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 à cocher cochée. Lorsque l'entrée est uncheckedValue, la cellule est affichée sous la forme d'une case à cocher non cochée.

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

Paramètres

NomTypeDescription
checkedValueObjectValeur attribuée à une case à cocher.
uncheckedValueObjectValeur attribuée à une case non cochée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDate()

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

// Set the data validation for cell A1 to require a date.
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger une date postérieure à la valeur indiquée. Les champs 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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireDateAfter(new Date('1/1/2013'))
                 .build();
cell.setDataValidation(rule);

Paramètres

NomTypeDescription
dateDateDernière date inacceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateBefore(date)

Définit la règle de validation des données pour exiger une date antérieure à la valeur indiquée. Les champs 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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireDateBefore(new Date('1/1/2013'))
                 .build();
cell.setDataValidation(rule);

Paramètres

NomTypeDescription
dateDateDate la plus ancienne non acceptée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateBetween(start, end)

Définit la règle de validation des données pour exiger une date comprise entre deux dates spécifiées ou correspondant à l'une d'elles. Les champs d'heure 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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation()
        .requireDateBetween(new Date('1/1/2013'), new Date('12/31/2013'))
        .build();
cell.setDataValidation(rule);

Paramètres

NomTypeDescription
startDateDate la plus ancienne acceptable.
endDateDernière date acceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateEqualTo(date)

Définit la règle de validation des données pour exiger une date égale à la valeur indiquée. Les champs 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 equal to January 1,
// 2013.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireDateEqualTo(new Date('1/1/2013'))
                 .build();
cell.setDataValidation(rule);

Paramètres

NomTypeDescription
dateDateSeule cette date est acceptée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateNotBetween(start, end)

Définit la règle de validation des données pour exiger une date qui ne se situe pas entre deux dates spécifiées et qui n'est aucune d'elles. Les champs d'heure 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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation()
        .requireDateNotBetween(new Date('1/1/2013'), new Date('12/31/2013'))
        .build();
cell.setDataValidation(rule);

Paramètres

NomTypeDescription
startDateDate la plus ancienne non acceptée.
endDateDernière date inacceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateOnOrAfter(date)

Définit la règle de validation des données pour exiger une date égale ou postérieure à la valeur indiquée. Les champs 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 on or after January 1,
// 2013.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireDateOnOrAfter(new Date('1/1/2013'))
                 .build();
cell.setDataValidation(rule);

Paramètres

NomTypeDescription
dateDateDate la plus ancienne acceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireDateOnOrBefore(date)

Définit la règle de validation des données pour exiger une date égale ou antérieure à la valeur indiquée. Les champs 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 on or before January 1,
// 2013.
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger que la formule donnée soit évaluée sur true.

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

Paramètres

NomTypeDescription
formulaStringFormule personnalisée qui renvoie 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 pour exiger un nombre compris entre deux nombres spécifiés ou égal à l'un d'eux.

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

Paramètres

NomTypeDescription
startNumberValeur minimale acceptable.
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 pour exiger un nombre égal à la valeur indiquée.

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

Paramètres

NomTypeDescription
numberNumberLa seule valeur acceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberGreaterThan(number)

Définit la règle de validation des données pour exiger un nombre supérieur à la valeur indiquée.

// Set the data validation for cell A1 to require a number greater than 0.
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger un nombre supérieur ou égal à la valeur indiquée.

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

Paramètres

NomTypeDescription
numberNumberValeur minimale acceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberLessThan(number)

Définit la règle de validation des données pour exiger un nombre inférieur à la valeur indiquée.

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

Paramètres

NomTypeDescription
numberNumberValeur la plus faible inacceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireNumberLessThanOrEqualTo(number)

Définit la règle de validation des données pour exiger un nombre inférieur ou égal à la valeur indiquée.

// Set the data validation for cell A1 to require a number less than or equal to
// 0.
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger un nombre qui ne se situe pas entre deux nombres spécifiés et qui n'est égal à aucun d'eux.

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

Paramètres

NomTypeDescription
startNumberValeur la plus faible 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 pour exiger un nombre différent de la valeur indiquée.

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

Paramètres

NomTypeDescription
numberNumberLa seule valeur non autorisée.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireTextContains(text)

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

// Set the data validation for cell A1 to require any value that includes
// "Google".
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger que la saisie ne contienne pas la valeur indiquée.

// Set the data validation for cell A1 to require any value that does not
// include "@".
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger que la saisie soit égale à la valeur indiquée.

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

Paramètres

NomTypeDescription
textStringLa seule valeur acceptable.

Renvois

DataValidationBuilder : ce compilateur, pour le chaînage


requireTextIsEmail()

Définit la règle de validation des données pour exiger que l'entrée soit une adresse e-mail.

// Set the data validation for cell A1 to require text in the form of an email
// address.
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger que l'entrée soit au format URL.

// Set the data validation for cell A1 to require text in the form of a URL.
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger que la saisie soit égale à l'une des valeurs indiquées.

// Set the data validation for cell A1 to require "Yes" or "No", with a dropdown
// menu.
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger que la saisie soit égale à l'une des valeurs indiqué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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const 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 pour exiger que la saisie soit égale à une valeur de la plage donnée.

// Set the data validation for cell A1 to require a value from B1:B10, with a
// dropdown menu.
const cell = SpreadsheetApp.getActive().getRange('A1');
const range = SpreadsheetApp.getActive().getRange('B1:B10');
const 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 pour exiger que la saisie soit égale à une valeur dans 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.
const cell = SpreadsheetApp.getActive().getRange('A1');
const range = SpreadsheetApp.getActive().getRange('B1:B10');
const 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)

Indique s'il faut afficher un avertissement lorsque la saisie échoue à la validation des données ou s'il faut rejeter complètement la saisie. 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)

Définit la règle de validation des données sur les critères définis par les valeurs DataValidationCriteria, généralement tirées des 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.
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);

Paramètres

NomTypeDescription
criteriaDataValidationCriteriaType de critère de validation des données.
argsObject[]Tableau d'arguments correspondant 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