Excel.DataValidation interface

Representa a validação de dados aplicada ao intervalo atual. Para saber mais sobre o modelo de objeto de validação de dados, leia Adicionar validação de dados para intervalos do Excel.

Propriedades

errorAlert

Alerta de erro quando o usuário insere dados inválidos.

ignoreBlanks

Especifica se a validação de dados será executada em células em branco, o padrão é true.

prompt

Avisar quando os usuários selecionarem uma célula.

rule

Regra de validação de dados que contém diferentes tipos de critérios de validação de dados.

type

Tipo de validação de dados, confira Excel.DataValidationType para obter detalhes.

valid

Representa se todos os valores de célula são válidos de acordo com as regras de validação de dados. Retorna true se todos os valores de célula forem válidos ou false se todos os valores de célula forem inválidos. Retorna NULL se houver valores de célula válidos e inválidos no intervalo.

Métodos

clear()

Desfazer a validação de dados do intervalo atual.

getInvalidCells()

Retorna um RangeAreas, que consiste em um ou mais intervalos retangulares, com valores inválidos de célula. Se todos os valores de célula forem válidos, essa função gerará um erro ItemNotFound.

getInvalidCellsOrNullObject()

Retorna um RangeAreas, que consiste em um ou mais intervalos retangulares, com valores inválidos de célula. Se todos os valores de célula forem válidos, essa função retornará null.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

Detalhes da propriedade

errorAlert

Alerta de erro quando o usuário insere dados inválidos.

errorAlert: DataValidationErrorAlert;

Valor da propriedade

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Decision");
    let 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: "Information",
        title: "Baby Name in Comment"
    };

    await context.sync();
}

ignoreBlanks

Especifica se a validação de dados será executada em células em branco, o padrão é true.

ignoreBlanks: boolean;

Valor da propriedade

boolean

prompt

Avisar quando os usuários selecionarem uma célula.

prompt: DataValidationPrompt;

Valor da propriedade

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Decision");
    let 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();
}

rule

Regra de validação de dados que contém diferentes tipos de critérios de validação de dados.

rule: DataValidationRule;

Valor da propriedade

Exemplos

async function main(context: Excel.RequestContext) {
    let sheet = context.workbook.worksheets.getItem("Decision");
    let 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();

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

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

    await context.sync();
}

type

Tipo de validação de dados, confira Excel.DataValidationType para obter detalhes.

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

Valor da propriedade

| DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria"

valid

Representa se todos os valores de célula são válidos de acordo com as regras de validação de dados. Retorna true se todos os valores de célula forem válidos ou false se todos os valores de célula forem inválidos. Retorna NULL se houver valores de célula válidos e inválidos no intervalo.

readonly valid: boolean;

Valor da propriedade

boolean

Detalhes do método

clear()

Desfazer a validação de dados do intervalo atual.

clear(): void;

Retornos

void

getInvalidCells()

Retorna um RangeAreas, que consiste em um ou mais intervalos retangulares, com valores inválidos de célula. Se todos os valores de célula forem válidos, essa função gerará um erro ItemNotFound.

getInvalidCells(): RangeAreas;

Retornos

getInvalidCellsOrNullObject()

Retorna um RangeAreas, que consiste em um ou mais intervalos retangulares, com valores inválidos de célula. Se todos os valores de célula forem válidos, essa função retornará null.

getInvalidCellsOrNullObject(): RangeAreas;

Retornos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void