Class DataValidation

اعتبارسنجی داده‌ها

دسترسی به قوانین اعتبارسنجی داده‌ها. برای ایجاد یک قانون جدید، SpreadsheetApp.newDataValidation() و DataValidationBuilder استفاده کنید. می‌توانید Range.setDataValidation(rule) برای تنظیم قانون اعتبارسنجی برای یک محدوده استفاده کنید.

// Log information about the data validation rule for cell A1.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = cell.getDataValidation();
if (rule != null) {
  const criteria = rule.getCriteriaType();
  const args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.');
}

روش‌ها

روش	نوع بازگشتی	شرح مختصر
copy()	Data Validation Builder	بر اساس تنظیمات این قانون، یک سازنده برای قانون اعتبارسنجی داده‌ها ایجاد می‌کند.
get Allow Invalid()	Boolean	اگر قانون هنگام عدم اعتبارسنجی ورودی، هشداری نشان دهد، true را برمی‌گرداند، و اگر ورودی را به طور کامل رد کند، false را برمی‌گرداند.
get Criteria Type()	Data Validation Criteria	نوع معیار قانون را همانطور که در شمارش Data Validation Criteria تعریف شده است، برمی‌گرداند.
get Criteria Values()	Object[]	آرایه‌ای از آرگومان‌ها را برای معیارهای قاعده دریافت می‌کند.
get Help Text()	String	متن راهنمای قانون را برمی‌گرداند، یا اگر متن راهنمایی تنظیم نشده باشد، null برمی‌گرداند.

مستندات دقیق

copy()

بر اساس تنظیمات این قانون، یک سازنده برای قانون اعتبارسنجی داده‌ها ایجاد می‌کند.

// Change existing data validation rules that require a date in 2013 to require
// a date in 2014.
const oldDates = [new Date('1/1/2013'), new Date('12/31/2013')];
const newDates = [new Date('1/1/2014'), new Date('12/31/2014')];
const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns());
const rules = range.getDataValidations();

for (let i = 0; i < rules.length; i++) {
  for (let j = 0; j < rules[i].length; j++) {
    const rule = rules[i][j];

    if (rule != null) {
      const criteria = rule.getCriteriaType();
      const args = rule.getCriteriaValues();

      if (criteria === SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN &&
          args[0].getTime() === oldDates[0].getTime() &&
          args[1].getTime() === oldDates[1].getTime()) {
        // Create a builder from the existing rule, then change the dates.
        rules[i][j] = rule.copy().withCriteria(criteria, newDates).build();
      }
    }
  }
}
range.setDataValidations(rules);

بازگشت

DataValidationBuilder — سازنده‌ای بر اساس تنظیمات این قانون

---

getAllowInvalid()

اگر قانون هنگام عدم اعتبارسنجی ورودی، هشداری نشان دهد، true را برمی‌گرداند، و اگر ورودی را به طور کامل رد کند، false را برمی‌گرداند. پیش‌فرض برای قوانین اعتبارسنجی داده‌های جدید، true است.

بازگشت

Boolean - اگر قانون اجازه ورود ورودی‌هایی را بدهد که اعتبارسنجی داده‌ها را با شکست مواجه می‌کنند، true و در غیر این صورت false برمی‌گرداند.

---

getCriteriaType()

نوع معیار قاعده را همانطور که در شمارش DataValidationCriteria تعریف شده است، دریافت می‌کند. برای دریافت آرگومان‌های معیار، getCriteriaValues() استفاده کنید. برای استفاده از این مقادیر برای ایجاد یا تغییر یک قاعده اعتبارسنجی داده، به DataValidationBuilder.withCriteria(criteria, args) مراجعه کنید.

// Log information about the data validation rule for cell A1.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = cell.getDataValidation();
if (rule != null) {
  const criteria = rule.getCriteriaType();
  const args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.');
}

بازگشت

DataValidationCriteria - نوع معیارهای اعتبارسنجی داده

---

getCriteriaValues()

آرایه‌ای از آرگومان‌ها را برای معیارهای قانون دریافت می‌کند. برای دریافت نوع معیار، getCriteriaType() استفاده کنید. برای استفاده از این مقادیر برای ایجاد یا تغییر یک قانون اعتبارسنجی داده‌ها، به DataValidationBuilder.withCriteria(criteria, args) مراجعه کنید.

// Log information about the data validation rule for cell A1.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = cell.getDataValidation();
if (rule != null) {
  const criteria = rule.getCriteriaType();
  const args = rule.getCriteriaValues();
  Logger.log('The data validation rule is %s %s', criteria, args);
} else {
  Logger.log('The cell does not have a data validation rule.');
}

بازگشت

Object[] — آرایه‌ای از آرگومان‌ها متناسب با نوع معیار قانون؛ تعداد آرگومان‌ها و نوع آنها با متد require...() مربوط به کلاس DataValidationBuilder مطابقت دارد.

---

getHelpText()

متن راهنمای قانون را برمی‌گرداند، یا اگر متن راهنمایی تنظیم نشده باشد، null برمی‌گرداند.

بازگشت

String - متن راهنمای قانون، یا اگر متن راهنمایی تنظیم نشده باشد null