ExcelScript.DataValidation interface

Paquete:

ExcelScript

Representa la validación de datos aplicada al intervalo actual.

Métodos

clear()	Borra la validación de datos del rango actual.
getErrorAlert()	Mensaje de error cuando el usuario escribe datos no válidos.
getIgnoreBlanks()	Especifica si la validación de datos se realizará en celdas en blanco. El valor predeterminado es true.
getInvalidCells()	Devuelve un RangeAreas objeto, que consta de uno o varios rangos rectangulares, con valores de celda no válidos. Si todos los valores de celda son válidos, esta función devolverá null.
getPrompt()	Preguntar cuándo los usuarios seleccionan una celda.
getRule()	Regla de validación de datos que contiene diferentes tipos de criterios de validación de datos.
getType()	Tipo de validación de datos, consulte ExcelScript.DataValidationType para obtener más información.
getValid()	Representa si todos los valores de celda son válidos de acuerdo con las reglas de validación de datos. Devuelve true si todos los valores de celda son válidos o false si todos los valores de celda no son válidos. Devuelve null si hay valores de celda válidos y no válidos dentro del intervalo.
setErrorAlert(errorAlert)	Mensaje de error cuando el usuario escribe datos no válidos.
setIgnoreBlanks(ignoreBlanks)	Especifica si la validación de datos se realizará en celdas en blanco. El valor predeterminado es true.
setPrompt(prompt)	Preguntar cuándo los usuarios seleccionan una celda.
setRule(rule)	Regla de validación de datos que contiene diferentes tipos de criterios de validación de datos.

Detalles del método

clear()

Borra la validación de datos del rango actual.

clear(): void;

Devoluciones

void

getErrorAlert()

Mensaje de error cuando el usuario escribe datos no válidos.

getErrorAlert(): DataValidationErrorAlert;

Devoluciones

ExcelScript.DataValidationErrorAlert

getIgnoreBlanks()

Especifica si la validación de datos se realizará en celdas en blanco. El valor predeterminado es true.

getIgnoreBlanks(): boolean;

Devoluciones

boolean

getInvalidCells()

Devuelve un RangeAreas objeto, que consta de uno o varios rangos rectangulares, con valores de celda no válidos. Si todos los valores de celda son válidos, esta función devolverá null.

getInvalidCells(): RangeAreas;

Devoluciones

ExcelScript.RangeAreas

getPrompt()

Preguntar cuándo los usuarios seleccionan una celda.

getPrompt(): DataValidationPrompt;

Devoluciones

ExcelScript.DataValidationPrompt

getRule()

Regla de validación de datos que contiene diferentes tipos de criterios de validación de datos.

getRule(): DataValidationRule;

Devoluciones

ExcelScript.DataValidationRule

getType()

Tipo de validación de datos, consulte ExcelScript.DataValidationType para obtener más información.

getType(): DataValidationType;

Devoluciones

ExcelScript.DataValidationType

Ejemplos

/**
 * 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 si todos los valores de celda son válidos de acuerdo con las reglas de validación de datos. Devuelve true si todos los valores de celda son válidos o false si todos los valores de celda no son válidos. Devuelve null si hay valores de celda válidos y no válidos dentro del intervalo.

getValid(): boolean;

Devoluciones

boolean

setErrorAlert(errorAlert)

Mensaje de error cuando el usuario escribe datos no válidos.

setErrorAlert(errorAlert: DataValidationErrorAlert): void;

Parámetros

errorAlert

ExcelScript.DataValidationErrorAlert

Devoluciones

void

setIgnoreBlanks(ignoreBlanks)

Especifica si la validación de datos se realizará en celdas en blanco. El valor predeterminado es true.

setIgnoreBlanks(ignoreBlanks: boolean): void;

Parámetros

ignoreBlanks

boolean

Devoluciones

void

setPrompt(prompt)

Preguntar cuándo los usuarios seleccionan una celda.

setPrompt(prompt: DataValidationPrompt): void;

Parámetros

prompt

ExcelScript.DataValidationPrompt

Devoluciones

void

Ejemplos

/**
 * 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)

Regla de validación de datos que contiene diferentes tipos de criterios de validación de datos.

setRule(rule: DataValidationRule): void;

Parámetros

rule

ExcelScript.DataValidationRule

Devoluciones

void

Ejemplos

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