Class DataValidation

DataValidation

גישה לכללי אימות הנתונים. כדי ליצור כלל חדש, משתמשים ב-SpreadsheetApp.newDataValidation() וב-DataValidationBuilder. אפשר להשתמש Range.setDataValidation(rule) כדי להגדיר את כלל האימות של טווח.

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var 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הפונקציה מקבלת את סוג הקריטריונים של הכלל כפי שמוגדר ב-enum DataValidationCriteria.
getCriteriaValues()Object[]הפונקציה מקבלת מערך של ארגומנטים לקריטריוני הכלל.
getHelpText()Stringהפונקציה מקבלת את טקסט העזרה של הכלל, או null אם לא הוגדר טקסט עזרה.

מסמכי תיעוד מפורטים

copy()

יצירת כלי ליצירת כלל לאימות נתונים על סמך ההגדרות של הכלל הזה.

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

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

    if (rule != null) {
      var criteria = rule.getCriteriaType();
      var 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 – כלי build שמבוסס על ההגדרות של הכלל הזה


getAllowInvalid()

הפונקציה מחזירה את הערך true אם הכלל מציג אזהרה כשהקלט נכשל באימות הנתונים, או false אם הוא דוחה את הקלט במלואו. ברירת המחדל של הכללים החדשים לאימות נתונים היא true.

חזרה

Booleantrue אם הכלל מאפשר קלט שנכשל באימות הנתונים; false אם לא


getCriteriaType()

הפונקציה מקבלת את סוג הקריטריונים של הכלל כפי שמוגדר ב-enum DataValidationCriteria. כדי לקבל את ארגומנטים של הקריטריונים, השתמשו ב-getCriteriaValues(). כדי להשתמש בערכים האלה כדי ליצור לשינוי כלל לאימות נתונים, ראו DataValidationBuilder.withCriteria(criteria, args).

// Log information about the data validation rule for cell A1.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var 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.
var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = cell.getDataValidation();
if (rule != null) {
  var criteria = rule.getCriteriaType();
  var 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 אם לא הוגדר טקסט עזרה