Share via

Excel.DataValidation class

  • Referência
Pacote:
excel

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 aos intervalos do Excel.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
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

Solicitar 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 da validação de dados, consulte 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 dentro do intervalo.

Métodos

clear()

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

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

Retorna um RangeAreas objeto, que compreende um ou mais intervalos retangulares, com valores de célula inválidos. Se todos os valores de célula forem válidos, essa função retornará null.
load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
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(propertyNamesAndPaths)

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

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.DataValidation original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DataValidationData) que contém cópias rasas de qualquer propriedade filho carregada do objeto original.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

errorAlert

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

errorAlert: Excel.DataValidationErrorAlert;

Valor da propriedade

Excel.DataValidationErrorAlert

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 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

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

prompt

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

prompt: Excel.DataValidationPrompt;

Valor da propriedade

Excel.DataValidationPrompt

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

rule

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

rule: Excel.DataValidationRule;

Valor da propriedade

Excel.DataValidationRule

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

type

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

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

Valor da propriedade

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

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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 dentro do intervalo.

readonly valid: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

Detalhes do método

clear()

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

clear(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

getInvalidCells()

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

getInvalidCells(): Excel.RangeAreas;

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

getInvalidCellsOrNullObject()

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

getInvalidCellsOrNullObject(): Excel.RangeAreas;

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

load(options)

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

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

Parâmetros

options
Excel.Interfaces.DataValidationLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.DataValidation

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[]): Excel.DataValidation;

Parâmetros

propertyNames

string | string[]

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

Retornos

Excel.DataValidation

load(propertyNamesAndPaths)

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

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

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.DataValidation

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties
Excel.Interfaces.DataValidationUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.DataValidation): void;

Parâmetros

properties
Excel.DataValidation

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.DataValidation original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DataValidationData) que contém cópias rasas de qualquer propriedade filho carregada do objeto original.

toJSON(): Excel.Interfaces.DataValidationData;

Retornos

Excel.Interfaces.DataValidationData