Excel.DataValidation class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

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

errorAlert: Excel.DataValidationErrorAlert;

Valeur de propriété

Remarques

Jeu 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 commentsRange = 
        sheet.tables.getItem("NameOptionsTable").columns.getItem("Comments").getDataBodyRange();

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

    // If the value of A2 is contained in the value of C2, then 
    // SEARCH(A2,C2) returns the number where it begins. Otherwise,
    // it does not return a number.
    let redundantStringRule = {
        custom: {
            formula: "=NOT(ISNUMBER(SEARCH(A2,C2)))"
        }
    };
    commentsRange.dataValidation.rule = redundantStringRule;
    commentsRange.dataValidation.errorAlert = {
        message: "It is redundant to include the baby name in the comment.",
        showAlert: true,
        style: Excel.DataValidationAlertStyle.information,
        title: "Baby Name in Comment"
    };

    await context.sync();
});

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

ignoreBlanks: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.8

Invite lorsque les utilisateurs sélectionnent une cellule.

prompt: Excel.DataValidationPrompt;

Valeur de propriété

Remarques

Jeu 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: Excel.DataValidationAlertStyle.stop,
        title: "Negative Number Entered"
    };

    await context.sync();
});

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

rule: Excel.DataValidationRule;

Valeur de propriété

Remarques

Jeu 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();
});

Type de validation des données, consultez Excel.DataValidationType pour plus de détails.

readonly type: Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria";

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.8

Représente si toutes les valeurs de cellule sont valides selon les règles de validation des données. Renvoie true si toutes les valeurs de cellule sont valides ou false si toutes les valeurs de cellule ne sont pas valides. Renvoie null si la plage contient à la fois des valeurs de cellule valides et non valides.

readonly valid: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.8

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

clear(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.8

Renvoie un objet comprenant une ou plusieurs plages rectangulaires avec des RangeAreas valeurs de cellule non valides. Si toutes les valeurs des cellules sont valides, cette fonction renvoie une ItemNotFound erreur.

getInvalidCells(): Excel.RangeAreas;

Retours

Remarques

Jeu d’API : ExcelApi 1.9

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

getInvalidCellsOrNullObject(): Excel.RangeAreas;

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.DataValidationLoadOptions): Excel.DataValidation;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.DataValidation;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.DataValidation;

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.DataValidationUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.DataValidation): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.DataValidation est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.DataValidationDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.DataValidationData;

Retours