Share via

ExcelScript.DataValidation interface

  • Ссылка
Пакет:
ExcelScript

Представляет проверку данных, применяемую к текущему диапазону.

Методы

clear()

Очищает проверку данных из текущего диапазона.
getErrorAlert()

Сообщение об ошибке, когда пользователь вводит недопустимые данные.
getIgnoreBlanks()

Указывает, будет ли выполняться проверка данных в пустых ячейках. По умолчанию используется значение true.
getInvalidCells()

Возвращает объект, состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, с недопустимыми значениями ячеек. Если все значения ячеек допустимы, этот метод возвращает null.
getPrompt()

Запрашивать, когда пользователи выбирают ячейку.
getRule()

Правило проверки данных, содержащее различные типы критериев проверки данных.
getType()

Тип проверки данных см ExcelScript.DataValidationType . дополнительные сведения.
getValid()

Указывает, являются ли все значения ячеек допустимыми в соответствии с правилами проверки данных. Возвращает значение true , если все значения ячеек являются допустимыми или false если все значения ячеек недопустимы. Возвращает значение null , если в диапазоне имеются допустимые и недопустимые значения ячеек.
setErrorAlert(errorAlert)

Сообщение об ошибке, когда пользователь вводит недопустимые данные.
setIgnoreBlanks(ignoreBlanks)

Указывает, будет ли выполняться проверка данных в пустых ячейках. По умолчанию используется значение true.
setPrompt(prompt)

Запрашивать, когда пользователи выбирают ячейку.
setRule(rule)

Правило проверки данных, содержащее различные типы критериев проверки данных.

Сведения о методе

clear()

Очищает проверку данных из текущего диапазона.

clear(): void;

Возвращаемое значение

void

getErrorAlert()

Сообщение об ошибке, когда пользователь вводит недопустимые данные.

getErrorAlert(): DataValidationErrorAlert;

Возвращаемое значение

ExcelScript.DataValidationErrorAlert

getIgnoreBlanks()

Указывает, будет ли выполняться проверка данных в пустых ячейках. По умолчанию используется значение true.

getIgnoreBlanks(): boolean;

Возвращаемое значение

boolean

getInvalidCells()

Возвращает объект, состоящий RangeAreas из одного или нескольких прямоугольных диапазонов, с недопустимыми значениями ячеек. Если все значения ячеек допустимы, этот метод возвращает null.

getInvalidCells(): RangeAreas;

Возвращаемое значение

ExcelScript.RangeAreas

getPrompt()

Запрашивать, когда пользователи выбирают ячейку.

getPrompt(): DataValidationPrompt;

Возвращаемое значение

ExcelScript.DataValidationPrompt

getRule()

Правило проверки данных, содержащее различные типы критериев проверки данных.

getRule(): DataValidationRule;

Возвращаемое значение

ExcelScript.DataValidationRule

getType()

Тип проверки данных см ExcelScript.DataValidationType . дополнительные сведения.

getType(): DataValidationType;

Возвращаемое значение

ExcelScript.DataValidationType

Примеры

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

Указывает, являются ли все значения ячеек допустимыми в соответствии с правилами проверки данных. Возвращает значение true , если все значения ячеек являются допустимыми или false если все значения ячеек недопустимы. Возвращает значение null , если в диапазоне имеются допустимые и недопустимые значения ячеек.

getValid(): boolean;

Возвращаемое значение

boolean

setErrorAlert(errorAlert)

Сообщение об ошибке, когда пользователь вводит недопустимые данные.

setErrorAlert(errorAlert: DataValidationErrorAlert): void;

Параметры

errorAlert
ExcelScript.DataValidationErrorAlert

Возвращаемое значение

void

setIgnoreBlanks(ignoreBlanks)

Указывает, будет ли выполняться проверка данных в пустых ячейках. По умолчанию используется значение true.

setIgnoreBlanks(ignoreBlanks: boolean): void;

Параметры

ignoreBlanks

boolean

Возвращаемое значение

void

setPrompt(prompt)

Запрашивать, когда пользователи выбирают ячейку.

setPrompt(prompt: DataValidationPrompt): void;

Параметры

prompt
ExcelScript.DataValidationPrompt

Возвращаемое значение

void

Примеры

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

Правило проверки данных, содержащее различные типы критериев проверки данных.

setRule(rule: DataValidationRule): void;

Параметры

rule
ExcelScript.DataValidationRule

Возвращаемое значение

void

Примеры

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