Compartilhar via


Excel.DataValidationRule interface

Uma regra de validação de dados contém diferentes tipos de validação de dados. Só pode utilizar um deles de cada vez de acordo com .Excel.DataValidationType

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Propriedades

custom

Critérios de validação de dados personalizados.

date

Critérios de validação de dados de data.

decimal

Critérios de validação de dados decimais.

list

Critérios de validação de dados da lista.

textLength

Critérios de validação de dados de comprimento de texto.

time

Critérios de validação de dados de tempo.

wholeNumber

Critérios de validação de dados de número inteiro.

Detalhes da propriedade

custom

Critérios de validação de dados personalizados.

custom?: Excel.CustomDataValidation;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

date

Critérios de validação de dados de data.

date?: Excel.DateTimeDataValidation;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

decimal

Critérios de validação de dados decimais.

decimal?: Excel.BasicDataValidation;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

list

Critérios de validação de dados da lista.

list?: Excel.ListDataValidation;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Exemplos

// 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érios de validação de dados de comprimento de texto.

textLength?: Excel.BasicDataValidation;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

time

Critérios de validação de dados de tempo.

time?: Excel.DateTimeDataValidation;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

wholeNumber

Critérios de validação de dados de número inteiro.

wholeNumber?: Excel.BasicDataValidation;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Exemplos

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