ExcelScript.DataValidationRule interface

Paket:

ExcelScript

Eine Datenüberprüfungsregel enthält verschiedene Arten der Datenüberprüfung. Sie können nur jeweils eine davon gemäß ExcelScript.DataValidationTypeverwenden.

Eigenschaften

custom	Kriterien für eine benutzerdefinierte Datenüberprüfung.
date	Kriterien für die Datenüberprüfung.
decimal	Kriterien für die dezimale Datenüberprüfung.
list	Führt die Kriterien für die Datenüberprüfung auf.
textLength	Überprüfungskriterien für Textlängendaten.
time	Kriterien für die Zeitdatenüberprüfung.
wholeNumber	Kriterien für die Datenvalidierung ganzer Zahlen.

Details zur Eigenschaft

custom

Kriterien für eine benutzerdefinierte Datenüberprüfung.

custom?: CustomDataValidation;

Eigenschaftswert

ExcelScript.CustomDataValidation

date

Kriterien für die Datenüberprüfung.

date?: DateTimeDataValidation;

Eigenschaftswert

ExcelScript.DateTimeDataValidation

decimal

Kriterien für die dezimale Datenüberprüfung.

decimal?: BasicDataValidation;

Eigenschaftswert

ExcelScript.BasicDataValidation

list

Führt die Kriterien für die Datenüberprüfung auf.

list?: ListDataValidation;

Eigenschaftswert

ExcelScript.ListDataValidation

Beispiele

/**
 * This script creates a dropdown selection list for a cell.
 * It uses the existing values of the selected range as the choices for the list.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the values for data validation.
    const selectedRange = workbook.getSelectedRange();
    const rangeValues = selectedRange.getValues();

    // Convert the values into a comma-delimited string.
    let dataValidationListString = "";
    rangeValues.forEach((rangeValueRow) => {
        rangeValueRow.forEach((value) => {
            dataValidationListString += value + ",";
        });
    });

    // Clear the old range.
    selectedRange.clear(ExcelScript.ClearApplyTo.contents);

    // Apply the data validation to the first cell in the selected range.
    const targetCell = selectedRange.getCell(0, 0);
    const dataValidation = targetCell.getDataValidation();

    // Set the content of the dropdown list.
    let validationCriteria : ExcelScript.ListDataValidation = {
        inCellDropDown: true,
        source: dataValidationListString
    };
    let validationRule: ExcelScript.DataValidationRule = {
        list: validationCriteria
    };
    dataValidation.setRule(validationRule);
}

textLength

Überprüfungskriterien für Textlängendaten.

textLength?: BasicDataValidation;

Eigenschaftswert

ExcelScript.BasicDataValidation

time

Kriterien für die Zeitdatenüberprüfung.

time?: DateTimeDataValidation;

Eigenschaftswert

ExcelScript.DateTimeDataValidation

wholeNumber

Kriterien für die Datenvalidierung ganzer Zahlen.

wholeNumber?: BasicDataValidation;

Eigenschaftswert

ExcelScript.BasicDataValidation

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