ExcelScript.DataValidation interface

Pacote:

ExcelScript

Representa a validação de dados aplicada ao intervalo atual.

Métodos

clear()	Desfazer a validação de dados do intervalo atual.
getErrorAlert()	Alerta de erro quando o usuário insere dados inválidos.
getIgnoreBlanks()	Especifica se a validação de dados será executada em células em branco. O padrão é true.
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, esse método retornará null.
getPrompt()	Solicitar quando os usuários selecionarem uma célula.
getRule()	Regra de validação de dados que contém diferentes tipos de critérios de validação de dados.
getType()	Tipo da validação de dados, consulte ExcelScript.DataValidationType para obter detalhes.
getValid()	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.
setErrorAlert(errorAlert)	Alerta de erro quando o usuário insere dados inválidos.
setIgnoreBlanks(ignoreBlanks)	Especifica se a validação de dados será executada em células em branco. O padrão é true.
setPrompt(prompt)	Solicitar quando os usuários selecionarem uma célula.
setRule(rule)	Regra de validação de dados que contém diferentes tipos de critérios de validação de dados.

Detalhes do método

clear()

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

clear(): void;

Retornos

void

getErrorAlert()

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

getErrorAlert(): DataValidationErrorAlert;

Retornos

ExcelScript.DataValidationErrorAlert

getIgnoreBlanks()

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

getIgnoreBlanks(): boolean;

Retornos

boolean

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, esse método retornará null.

getInvalidCells(): RangeAreas;

Retornos

ExcelScript.RangeAreas

getPrompt()

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

getPrompt(): DataValidationPrompt;

Retornos

ExcelScript.DataValidationPrompt

getRule()

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

getRule(): DataValidationRule;

Retornos

ExcelScript.DataValidationRule

getType()

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

getType(): DataValidationType;

Retornos

ExcelScript.DataValidationType

Exemplos

/**
 * This sample reads and logs the data validation type of the currently selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the currently selected range.
  let range = workbook.getSelectedRange();

  // Get the type (`DataValidationType`) of data validation applied to the range.
  let validationType = range.getDataValidation().getType();

  /*
   * Log the data validation type.
   * If the range has a single value, it logs that type.
   * If the range doesn't have data validation applied, it logs "None".
   * If the range has multiple different types of data validation, it logs "Inconsistent" or "MixedCriteria".
   */
  console.log(validationType.toString());
}

getValid()

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.

getValid(): boolean;

Retornos

boolean

setErrorAlert(errorAlert)

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

setErrorAlert(errorAlert: DataValidationErrorAlert): void;

Parâmetros

errorAlert

ExcelScript.DataValidationErrorAlert

Retornos

void

setIgnoreBlanks(ignoreBlanks)

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

setIgnoreBlanks(ignoreBlanks: boolean): void;

Parâmetros

ignoreBlanks

boolean

Retornos

void

setPrompt(prompt)

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

setPrompt(prompt: DataValidationPrompt): void;

Parâmetros

prompt

ExcelScript.DataValidationPrompt

Retornos

void

Exemplos

/**
 * This script creates a text prompt that's shown in C2:C8 when a user enters the cell.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the data validation object for C2:C8 in the current worksheet.
    let selectedSheet = workbook.getActiveWorksheet();
    let dataValidation = selectedSheet.getRange("C2:C8").getDataValidation();

    // Clear any previous validation to avoid conflicts.
    dataValidation.clear();

    // Create a prompt to remind users to only enter first names in this column.
    dataValidation.setPrompt({ 
        showPrompt: true, 
        title: "First names only", 
        message: "Only enter the first name of the employee, not the full name." 
    });
}    

setRule(rule)

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

setRule(rule: DataValidationRule): void;

Parâmetros

rule

ExcelScript.DataValidationRule

Retornos

void

Exemplos

/**
 * This script creates a data validation rule for the range B1:B5.
 * All values in that range must be a positive number.
 * Attempts to enter other values are blocked and an error message appears.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range B1:B5 in the active worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const positiveNumberOnlyCells = currentSheet.getRange("B1:B5");

  // Create a data validation rule to only allow positive numbers.
  const positiveNumberValidation: ExcelScript.BasicDataValidation = {
    formula1: "0",
    operator: ExcelScript.DataValidationOperator.greaterThan
  };
  const positiveNumberOnlyRule: ExcelScript.DataValidationRule = {
    wholeNumber: positiveNumberValidation
  };

  // Set the rule on the range.
  const rangeDataValidation = positiveNumberOnlyCells.getDataValidation();
  rangeDataValidation.setRule(positiveNumberOnlyRule);

  // Create an alert to appear when data other than positive numbers are entered.
  const positiveNumberOnlyAlert: ExcelScript.DataValidationErrorAlert = {
    message: "Positive numbers only",
    showAlert: true,
    style: ExcelScript.DataValidationAlertStyle.stop,
    title: "Invalid data"
  };
  rangeDataValidation.setErrorAlert(positiveNumberOnlyAlert);
}