Class DataValidationBuilder

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

Aller-retour

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

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

Aller-retour

DataValidationBuilder : compilateur basé sur les paramètres de cette règle.

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

Aller-retour

Boolean — true si la règle autorise la saisie qui échoue à la validation des données ; false dans le cas contraire

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(). Pour utiliser ces valeurs afin de 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.')
}

Aller-retour

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

Récupère 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 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.')
}

Aller-retour

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.

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

Aller-retour

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

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 forme de 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);

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger que l'entrée soit vide ou la valeur spécifiée. Lorsque l'entrée correspond à la valeur spécifiée, la cellule est affichée sous la forme d'une case cochée. Lorsque l'entrée est vide, la cellule est affichée sous la forme d'une 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

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 cochée. Lorsque l'entrée est uncheckedValue, la cellule est affichée sous la forme d'une 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données sur "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);

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour qu'elle nécessite une date après la valeur donnée. Les champs de type "time" de l'objet Date sont ignorés. Seuls les champs "day", "month" et "year" 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données sur une date antérieure à la valeur donnée. Les champs de type "time" de l'objet Date sont ignorés. Seuls les champs "day", "month" et "year" 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger une date comprise entre deux dates spécifiées. Les champs de date 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour qu'elle exige une date égale à la valeur donnée. Les champs de type "time" de l'objet Date sont ignorés. Seuls les champs "day", "month" et "year" 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger une date qui ne soit pas comprise entre deux dates spécifiées. Les champs de date 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données de sorte qu'elle demande une date égale ou postérieure à la valeur donnée. Les champs de type "time" de l'objet Date sont ignorés. Seuls les champs "day", "month" et "year" 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données de sorte qu'elle exige une date égale ou antérieure à la valeur donnée. Les champs de type "time" de l'objet Date sont ignorés. Seuls les champs "day", "month" et "year" 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour qu'elle demande un nombre compris entre deux chiffres spécifiés.

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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données de sorte qu'elle demande 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour qu'elle demande 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données de sorte qu'elle demande 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger qu'un nombre compris entre deux et aucun des nombres spécifiés ne soit pas compris.

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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger que les données soient saisies 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);

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger que la saisie 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);

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger que l'entrée soit égale à l'une des valeurs données, avec une option permettant 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger que l'entrée 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.
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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Définit la règle de validation des données pour exiger que l'entrée soit égale à une valeur de la plage donnée, avec une option permettant 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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

Détermine si un avertissement doit s'afficher en cas d'échec de la validation des données ou si l'entrée doit être entièrement refusée. La valeur par défaut pour les nouvelles règles de validation de données est true.

Paramètres

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage

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

Aller-retour

DataValidationBuilder : cet outil de création, pour le chaînage