Class DataValidation

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 إذا لم يتم ضبط أي نص مساعدة