ExcelScript.DataValidation interface

Paquet:

ExcelScript

Représente la validation des données appliquée à la plage actuelle.

Méthodes

clear()	Efface la validation des données de la plage active.
getErrorAlert()	Alerte d’erreur lorsque l’utilisateur entre des données non valides.
getIgnoreBlanks()	Spécifie si la validation des données sera effectuée sur des cellules vides. La valeur par défaut est true.
getInvalidCells()	Retourne un RangeAreas objet, comprenant une ou plusieurs plages rectangulaires, avec des valeurs de cellule non valides. Si toutes les valeurs de cellule sont valides, cette fonction retourne null.
getPrompt()	Invite lorsque les utilisateurs sélectionnent une cellule.
getRule()	Règle de validation des données qui contient différents types de critères de validation des données.
getType()	Type de validation des données, consultez ExcelScript.DataValidationType pour plus d’informations.
getValid()	Représente si toutes les valeurs de cellule sont valides selon les règles de validation des données. Retourne true si toutes les valeurs de cellule sont valides ou false si toutes les valeurs de cellule ne sont pas valides. Retourne null s’il existe des valeurs de cellule valides et non valides dans la plage.
setErrorAlert(errorAlert)	Alerte d’erreur lorsque l’utilisateur entre des données non valides.
setIgnoreBlanks(ignoreBlanks)	Spécifie si la validation des données sera effectuée sur des cellules vides. La valeur par défaut est true.
setPrompt(prompt)	Invite lorsque les utilisateurs sélectionnent une cellule.
setRule(rule)	Règle de validation des données qui contient différents types de critères de validation des données.

Détails de la méthode

clear()

Efface la validation des données de la plage active.

clear(): void;

Retours

void

getErrorAlert()

Alerte d’erreur lorsque l’utilisateur entre des données non valides.

getErrorAlert(): DataValidationErrorAlert;

Retours

ExcelScript.DataValidationErrorAlert

getIgnoreBlanks()

Spécifie si la validation des données sera effectuée sur des cellules vides. La valeur par défaut est true.

getIgnoreBlanks(): boolean;

Retours

boolean

getInvalidCells()

Retourne un RangeAreas objet, comprenant une ou plusieurs plages rectangulaires, avec des valeurs de cellule non valides. Si toutes les valeurs de cellule sont valides, cette fonction retourne null.

getInvalidCells(): RangeAreas;

Retours

ExcelScript.RangeAreas

getPrompt()

Invite lorsque les utilisateurs sélectionnent une cellule.

getPrompt(): DataValidationPrompt;

Retours

ExcelScript.DataValidationPrompt

getRule()

Règle de validation des données qui contient différents types de critères de validation des données.

getRule(): DataValidationRule;

Retours

ExcelScript.DataValidationRule

getType()

Type de validation des données, consultez ExcelScript.DataValidationType pour plus d’informations.

getType(): DataValidationType;

Retours

ExcelScript.DataValidationType

Exemples

/**
 * This sample reads and logs the data validation type of the currently selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the currently selected range.
  let range = workbook.getSelectedRange();

  // Get the type (`DataValidationType`) of data validation applied to the range.
  let validationType = range.getDataValidation().getType();

  /*
   * Log the data validation type.
   * If the range has a single value, it logs that type.
   * If the range doesn't have data validation applied, it logs "None".
   * If the range has multiple different types of data validation, it logs "Inconsistent" or "MixedCriteria".
   */
  console.log(validationType.toString());
}

getValid()

Représente si toutes les valeurs de cellule sont valides selon les règles de validation des données. Retourne true si toutes les valeurs de cellule sont valides ou false si toutes les valeurs de cellule ne sont pas valides. Retourne null s’il existe des valeurs de cellule valides et non valides dans la plage.

getValid(): boolean;

Retours

boolean

setErrorAlert(errorAlert)

Alerte d’erreur lorsque l’utilisateur entre des données non valides.

setErrorAlert(errorAlert: DataValidationErrorAlert): void;

Paramètres

errorAlert

ExcelScript.DataValidationErrorAlert

Retours

void

setIgnoreBlanks(ignoreBlanks)

Spécifie si la validation des données sera effectuée sur des cellules vides. La valeur par défaut est true.

setIgnoreBlanks(ignoreBlanks: boolean): void;

Paramètres

ignoreBlanks

boolean

Retours

void

setPrompt(prompt)

Invite lorsque les utilisateurs sélectionnent une cellule.

setPrompt(prompt: DataValidationPrompt): void;

Paramètres

prompt

ExcelScript.DataValidationPrompt

Retours

void

Exemples

/**
 * This script creates a text prompt that's shown in C2:C8 when a user enters the cell.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the data validation object for C2:C8 in the current worksheet.
    let selectedSheet = workbook.getActiveWorksheet();
    let dataValidation = selectedSheet.getRange("C2:C8").getDataValidation();

    // Clear any previous validation to avoid conflicts.
    dataValidation.clear();

    // Create a prompt to remind users to only enter first names in this column.
    dataValidation.setPrompt({ 
        showPrompt: true, 
        title: "First names only", 
        message: "Only enter the first name of the employee, not the full name." 
    });
}    

setRule(rule)

Règle de validation des données qui contient différents types de critères de validation des données.

setRule(rule: DataValidationRule): void;

Paramètres

rule

ExcelScript.DataValidationRule

Retours

void

Exemples

/**
 * This script creates a data validation rule for the range B1:B5.
 * All values in that range must be a positive number.
 * Attempts to enter other values are blocked and an error message appears.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range B1:B5 in the active worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");

  // Create a data validation rule to only allow positive numbers.
  const positiveNumberValidation: ExcelScript.BasicDataValidation = {
    formula1: "0",
    operator: ExcelScript.DataValidationOperator.greaterThan
  };
  const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
    wholeNumber: positiveNumberValidation
  };

  // Set the rule on the range.
  const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
  rangeDataValidation.setRule(positiveNumberOnlyRule);

  // Create an alert to appear when data other than positive numbers are entered.
  const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
    message: "Positive numbers only",
    showAlert: true,
    style: ExcelScript.DataValidationAlertStyle.stop,
    title: "Invalid data"
  };
  rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
}