Excel.DataValidationRule interface

Paquet:

excel

Une règle de validation des données contient différents types de validation de données. Vous ne pouvez utiliser qu’un seul d’entre eux à la fois en fonction du Excel.DataValidationType.

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Propriétés

custom	Critères de validation des données personnalisés.
date	Critères de validation des données de date.
decimal	Critères de validation des données décimales.
list	Critères de validation des données de liste.
textLength	Critères de validation des données de longueur de texte.
time	Critères de validation des données de temps.
wholeNumber	Critères de validation des données de nombre entier.

Détails de la propriété

custom

Critères de validation des données personnalisés.

custom?: Excel.CustomDataValidation;

Valeur de propriété

Excel.CustomDataValidation

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

date

Critères de validation des données de date.

date?: Excel.DateTimeDataValidation;

Valeur de propriété

Excel.DateTimeDataValidation

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

decimal

Critères de validation des données décimales.

decimal?: Excel.BasicDataValidation;

Valeur de propriété

Excel.BasicDataValidation

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

list

Critères de validation des données de liste.

list?: Excel.ListDataValidation;

Valeur de propriété

Excel.ListDataValidation

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Decision");
    const nameRange = 
        sheet.tables.getItem("NameOptionsTable").columns.getItem("Baby Name").getDataBodyRange();

    // When you are developing, it is a good practice to
    // clear the dataValidation object with each run of your code.
    nameRange.dataValidation.clear();

    const nameSourceRange = context.workbook.worksheets.getItem("Names").getRange("A1:A3");

    let approvedListRule = {
        list: {
            inCellDropDown: true,
            source: nameSourceRange
        }
    };
    nameRange.dataValidation.rule = approvedListRule;

    await context.sync();
});

textLength

Critères de validation des données de longueur de texte.

textLength?: Excel.BasicDataValidation;

Valeur de propriété

Excel.BasicDataValidation

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

time

Critères de validation des données de temps.

time?: Excel.DateTimeDataValidation;

Valeur de propriété

Excel.DateTimeDataValidation

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

wholeNumber

Critères de validation des données de nombre entier.

wholeNumber?: Excel.BasicDataValidation;

Valeur de propriété

Excel.BasicDataValidation

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Decision");
    const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange();

    // When you are developing, it is a good practice to
    // clear the dataValidation object with each run of your code.
    rankingRange.dataValidation.clear();

    let greaterThanZeroRule = {
        wholeNumber: {
            formula1: 0,
            operator: Excel.DataValidationOperator.greaterThan
        }
    };
    rankingRange.dataValidation.rule = greaterThanZeroRule;

    rankingRange.dataValidation.prompt = {
        message: "Please enter a positive number.",
        showPrompt: true,
        title: "Positive numbers only."
    };

    rankingRange.dataValidation.errorAlert = {
        message: "Sorry, only positive numbers are allowed",
        showAlert: true,
        style: "Stop",
        title: "Negative Number Entered"
    };

    await context.sync();
});