ExcelScript.DataValidation interface

Paket:

ExcelScript

Stellt die Datenüberprüfung dar, die auf den aktuellen Bereich angewendet wird.

Methoden

clear()	Löscht die Datenüberprüfung aus dem aktuellen Bereich.
getErrorAlert()	Fehlermeldung, wenn Benutzer ungültige Daten eingibt.
getIgnoreBlanks()	Gibt an, ob die Datenüberprüfung für leere Zellen ausgeführt wird. Der Standardwert ist true.
getInvalidCells()	Gibt ein RangeAreas Objekt zurück, das einen oder mehrere rechteckige Bereiche mit ungültigen Zellwerten umfasst. Wenn alle Zellwerte gültig sind, gibt diese Methode zurück null.
getPrompt()	Aufforderung, wenn Benutzer eine Zelle auswählen.
getRule()	Datenüberprüfungsregel, die verschiedene Arten von Datenüberprüfungskriterien enthält.
getType()	Weitere Informationen finden Sie unter ExcelScript.DataValidationType Typ der Datenüberprüfung.
getValid()	Gibt an, ob alle Zellwerte entsprechend den Datenüberprüfungsregeln gültig sind. Gibt zurück true , wenn alle Zellwerte gültig sind oder false wenn alle Zellwerte ungültig sind. Gibt zurück null , wenn innerhalb des Bereichs sowohl gültige als auch ungültige Zellwerte vorhanden sind.
setErrorAlert(errorAlert)	Fehlermeldung, wenn Benutzer ungültige Daten eingibt.
setIgnoreBlanks(ignoreBlanks)	Gibt an, ob die Datenüberprüfung für leere Zellen ausgeführt wird. Der Standardwert ist true.
setPrompt(prompt)	Aufforderung, wenn Benutzer eine Zelle auswählen.
setRule(rule)	Datenüberprüfungsregel, die verschiedene Arten von Datenüberprüfungskriterien enthält.

Details zur Methode

clear()

Löscht die Datenüberprüfung aus dem aktuellen Bereich.

clear(): void;

Gibt zurück

void

getErrorAlert()

Fehlermeldung, wenn Benutzer ungültige Daten eingibt.

getErrorAlert(): DataValidationErrorAlert;

Gibt zurück

ExcelScript.DataValidationErrorAlert

getIgnoreBlanks()

Gibt an, ob die Datenüberprüfung für leere Zellen ausgeführt wird. Der Standardwert ist true.

getIgnoreBlanks(): boolean;

Gibt zurück

boolean

getInvalidCells()

Gibt ein RangeAreas Objekt zurück, das einen oder mehrere rechteckige Bereiche mit ungültigen Zellwerten umfasst. Wenn alle Zellwerte gültig sind, gibt diese Methode zurück null.

getInvalidCells(): RangeAreas;

Gibt zurück

ExcelScript.RangeAreas

getPrompt()

Aufforderung, wenn Benutzer eine Zelle auswählen.

getPrompt(): DataValidationPrompt;

Gibt zurück

ExcelScript.DataValidationPrompt

getRule()

Datenüberprüfungsregel, die verschiedene Arten von Datenüberprüfungskriterien enthält.

getRule(): DataValidationRule;

Gibt zurück

ExcelScript.DataValidationRule

getType()

Weitere Informationen finden Sie unter ExcelScript.DataValidationType Typ der Datenüberprüfung.

getType(): DataValidationType;

Gibt zurück

ExcelScript.DataValidationType

Beispiele

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

Gibt an, ob alle Zellwerte entsprechend den Datenüberprüfungsregeln gültig sind. Gibt zurück true , wenn alle Zellwerte gültig sind oder false wenn alle Zellwerte ungültig sind. Gibt zurück null , wenn innerhalb des Bereichs sowohl gültige als auch ungültige Zellwerte vorhanden sind.

getValid(): boolean;

Gibt zurück

boolean

setErrorAlert(errorAlert)

Fehlermeldung, wenn Benutzer ungültige Daten eingibt.

setErrorAlert(errorAlert: DataValidationErrorAlert): void;

Parameter

errorAlert

ExcelScript.DataValidationErrorAlert

Gibt zurück

void

setIgnoreBlanks(ignoreBlanks)

Gibt an, ob die Datenüberprüfung für leere Zellen ausgeführt wird. Der Standardwert ist true.

setIgnoreBlanks(ignoreBlanks: boolean): void;

Parameter

ignoreBlanks

boolean

Gibt zurück

void

setPrompt(prompt)

Aufforderung, wenn Benutzer eine Zelle auswählen.

setPrompt(prompt: DataValidationPrompt): void;

Parameter

prompt

ExcelScript.DataValidationPrompt

Gibt zurück

void

Beispiele

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

Datenüberprüfungsregel, die verschiedene Arten von Datenüberprüfungskriterien enthält.

setRule(rule: DataValidationRule): void;

Parameter

rule

ExcelScript.DataValidationRule

Gibt zurück

void

Beispiele

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