דף זה תורגם על ידי Cloud Translation API.

Class 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 – כלי המבוסס על ההגדרות של הכלל הזה

`getAllowInvalid()`

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

החזרות

Boolean – true אם הכלל מאפשר קלט שנכשל באימות הנתונים; 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 אם לא הוגדר טקסט עזרה