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.');
}

Methods

שיטהסוג הערך המוחזרתיאור קצר
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 – ה-builder מבוסס על ההגדרות של הכלל הזה

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 אם לא מוגדר טקסט עזרה