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()DataValidationBuilderتُنشئ أداة لإنشاء قاعدة للتحقّق من صحة البيانات استنادًا إلى إعدادات هذه القاعدة.
getAllowInvalid()Booleanتعرِض القيمة true إذا كانت القاعدة تعرِض تحذيرًا عندما يتعذّر إكمال عملية التحقّق من البيانات، أو false إذا كانت ترفض الإدخال بالكامل.
getCriteriaType()DataValidationCriteriaتحصل على نوع معايير القاعدة كما هو محدّد في التعداد DataValidationCriteria.
getCriteriaValues()Object[]تحصل على صفيف من الوسيطات لمعايير القاعدة.
getHelpText()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 في حال عدم ضبط نص مساعدة