Class DataValidationBuilder

DataValidationBuilder

כלי ליצירת כללים לאימות נתונים. 

// Set the data validation for cell A1 to require a value from B1:B10.
const cell = SpreadsheetApp.getActive().getRange('A1');
const range = SpreadsheetApp.getActive().getRange('B1:B10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

Methods

שיטהסוג הערך שמוחזרתיאור קצר
build()DataValidationיוצר כלל לאימות נתונים מההגדרות שחלות על הכלי ליצירת כללים.
copy()DataValidationBuilderיוצרת builder לכלל אימות נתונים על סמך ההגדרות של הכלל הזה.
getAllowInvalid()Booleanהפונקציה מחזירה true אם הכלל מציג אזהרה כשהקלט נכשל באימות הנתונים, או false אם היא דוחה את הקלט לחלוטין.
getCriteriaType()DataValidationCriteriaמחזירה את סוג הקריטריון של הכלל כפי שמוגדר ב-enum ‏DataValidationCriteria.
getCriteriaValues()Object[]מחזירה מערך של ארגומנטים לקריטריונים של הכלל.
getHelpText()Stringמחזירה את טקסט העזרה של הכלל, או null אם לא הוגדר טקסט עזרה.
requireCheckbox()DataValidationBuilderמגדיר את כלל אימות הנתונים כך שהקלט יהיה ערך בוליאני. הערך הזה מוצג כתיבת סימון.
requireCheckbox(checkedValue)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שהקלט יהיה הערך שצוין או ריק.
requireCheckbox(checkedValue, uncheckedValue)DataValidationBuilderהגדרת כלל לאימות נתונים שדורש שהקלט יהיה אחד מהערכים שצוינו.
requireDate()DataValidationBuilderמגדירה את כלל אימות הנתונים כך שנדרש תאריך.
requireDateAfter(date)DataValidationBuilderמגדירה את כלל אימות הנתונים כך שיידרש תאריך אחרי הערך שצוין.
requireDateBefore(date)DataValidationBuilderמגדירה את כלל אימות הנתונים כך שיידרש תאריך לפני הערך שצוין.
requireDateBetween(start, end)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שיידרש תאריך שחל בין שני תאריכים שצוינו, או שהוא אחד מהם.
requireDateEqualTo(date)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שנדרש תאריך ששווה לערך הנתון.
requireDateNotBetween(start, end)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שיידרש תאריך שלא חל בין שני תאריכים שצוינו, ולא שווה לאף אחד מהם.
requireDateOnOrAfter(date)DataValidationBuilderמגדירה את כלל אימות הנתונים כך שנדרש תאריך שחל בתאריך הנתון או אחריו.
requireDateOnOrBefore(date)DataValidationBuilderהכלל לאימות הנתונים מגדיר שצריך להזין תאריך שחל ביום הערך שצוין או לפניו.
requireFormulaSatisfied(formula)DataValidationBuilderמגדירה את כלל אימות הנתונים כך שהנוסחה הנתונה תניב את הערך true.
requireNumberBetween(start, end)DataValidationBuilderהפונקציה מגדירה את כלל אימות הנתונים כך שנדרש מספר שנמצא בין שני מספרים שצוינו, או ששווה לאחד מהם.
requireNumberEqualTo(number)DataValidationBuilderמגדירה את כלל אימות הנתונים כך שיידרש מספר ששווה לערך הנתון.
requireNumberGreaterThan(number)DataValidationBuilderמגדירה את הכלל לאימות נתונים כך שיידרש מספר שגדול מהערך שצוין.
requireNumberGreaterThanOrEqualTo(number)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שיידרש מספר שגדול מהערך הנתון או שווה לו.
requireNumberLessThan(number)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שיידרש מספר שקטן מהערך שצוין.
requireNumberLessThanOrEqualTo(number)DataValidationBuilderהפונקציה מגדירה את כלל אימות הנתונים כך שיידרש מספר שקטן מהערך שצוין או שווה לו.
requireNumberNotBetween(start, end)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שנדרש מספר שלא נמצא בין שני מספרים שצוינו, ולא שווה לאף אחד מהם.
requireNumberNotEqualTo(number)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שיידרש מספר שלא שווה לערך הנתון.
requireTextContains(text)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שהקלט יצטרך להכיל את הערך שצוין.
requireTextDoesNotContain(text)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שהקלט לא יכיל את הערך שצוין.
requireTextEqualTo(text)DataValidationBuilderהפונקציה מגדירה את כלל אימות הנתונים כך שהקלט יהיה שווה לערך הנתון.
requireTextIsEmail()DataValidationBuilderמגדירה את כלל אימות הנתונים כך שהקלט יהיה בפורמט של כתובת אימייל.
requireTextIsUrl()DataValidationBuilderהגדרת כלל לאימות נתונים שדורש שהקלט יהיה בפורמט של כתובת URL.
requireValueInList(values)DataValidationBuilderהפונקציה מגדירה את כלל אימות הנתונים כך שהקלט יהיה שווה לאחד מהערכים שצוינו.
requireValueInList(values, showDropdown)DataValidationBuilderהגדרת כלל לאימות נתונים שקובע שהקלט צריך להיות שווה לאחד מהערכים שצוינו, עם אפשרות להסתיר את התפריט הנפתח.
requireValueInRange(range)DataValidationBuilderמגדירה את כלל אימות הנתונים כך שהקלט יהיה שווה לערך בטווח הנתון.
requireValueInRange(range, showDropdown)DataValidationBuilderמגדיר את כלל אימות הנתונים כך שהקלט צריך להיות שווה לערך בטווח הנתון, עם אפשרות להסתיר את התפריט הנפתח.
setAllowInvalid(allowInvalidData)DataValidationBuilderההגדרה קובעת אם להציג אזהרה כשקלט נכשל באימות נתונים, או לדחות את הקלט לחלוטין.
setHelpText(helpText)DataValidationBuilderמגדיר את טקסט העזרה שמופיע כשמעבירים את העכבר מעל התא שבו מוגדר אימות נתונים.
withCriteria(criteria, args)DataValidationBuilderמגדירה את הכלל לאימות נתונים לפי קריטריונים שמוגדרים על ידי ערכי DataValidationCriteria, בדרך כלל מתוך criteria ו-arguments של כלל קיים.

תיעוד מפורט

build()

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

חזרה

‫DataValidation – ייצוג של כלל אימות הנתונים

copy()

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

// 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()

מחזירה את סוג הקריטריון של הכלל כפי שמוגדר ב-enum ‏DataValidationCriteria. כדי לקבל את הארגומנטים של הקריטריונים, משתמשים בפונקציה getCriteriaValues(). כדי להשתמש בערכים האלה כדי ליצור או לשנות כלל לאימות נתונים, אפשר לעיין במאמר 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(). כדי להשתמש בערכים האלה ליצירה או לשינוי של כלל לאימות נתונים, אפשר לעיין במאמר 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 אם לא מוגדר טקסט עזרה

requireCheckbox()

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

// Set the data validation for cell A1 to require a boolean value; the value is
// rendered as a checkbox.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation().requireCheckbox().build();
cell.setDataValidation(rule);

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireCheckbox(checkedValue)

מגדיר את כלל אימות הנתונים כך שהקלט יהיה הערך שצוין או ריק. אם הקלט תואם לערך שצוין, התא מוצג כתיבת סימון מסומנת. אם הקלט ריק, התא מוצג כתיבת סימון לא מסומנת. 

// Set the data validation for cell A1 to require a custom checked value that is
// rendered as a checkbox.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation().requireCheckbox('APPROVED').build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
checkedValueObjectהערך שמוקצה לתיבה מסומנת.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireCheckbox(checkedValue, uncheckedValue)

הגדרת כלל לאימות נתונים שדורש שהקלט יהיה אחד מהערכים שצוינו. כשהקלט הוא checkedValue התא מוצג כתיבת סימון מסומנת. אם הקלט הוא uncheckedValue, התא מוצג כתיבת סימון לא מסומנת. 

// Set the data validation for cell A1 to require custom checked values that are
// rendered as a checkbox.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireCheckbox('APPROVED', 'PENDING')
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
checkedValueObjectהערך שמוקצה לתיבה מסומנת.
uncheckedValueObjectהערך שמוקצה לתיבה לא מסומנת.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireDate()

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

// Set the data validation for cell A1 to require a date.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation().requireDate().build();
cell.setDataValidation(rule);

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireDateAfter(date)

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

// Set the data validation for cell A1 to require a date after January 1, 2013.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireDateAfter(new Date('1/1/2013'))
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
dateDateהתאריך האחרון הלא קביל.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireDateBefore(date)

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

// Set the data validation for cell A1 to require a date before January 1, 2013.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireDateBefore(new Date('1/1/2013'))
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
dateDateהתאריך המוקדם ביותר שלא קביל.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireDateBetween(start, end)

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

// Set the data validation for cell A1 to require a date in 2013.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation()
        .requireDateBetween(new Date('1/1/2013'), new Date('12/31/2013'))
        .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
startDateהתאריך המוקדם ביותר שאפשר להשתמש בו.
endDateהתאריך המאוחר ביותר שאפשר להשתמש בו.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireDateEqualTo(date)

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

// Set the data validation for cell A1 to require a date equal to January 1,
// 2013.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireDateEqualTo(new Date('1/1/2013'))
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
dateDateהתאריך היחיד שניתן להשתמש בו.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireDateNotBetween(start, end)

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

// Set the data validation for cell A1 to require a date not in 2013.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation()
        .requireDateNotBetween(new Date('1/1/2013'), new Date('12/31/2013'))
        .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
startDateהתאריך המוקדם ביותר שלא קביל.
endDateהתאריך האחרון הלא קביל.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireDateOnOrAfter(date)

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

// Set the data validation for cell A1 to require a date on or after January 1,
// 2013.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireDateOnOrAfter(new Date('1/1/2013'))
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
dateDateהתאריך המוקדם ביותר שאפשר להשתמש בו.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireDateOnOrBefore(date)

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

// Set the data validation for cell A1 to require a date on or before January 1,
// 2013.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireDateOnOrBefore(new Date('1/1/2013'))
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
dateDateהתאריך המאוחר ביותר שאפשר להשתמש בו.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireFormulaSatisfied(formula)

מגדירה את כלל אימות הנתונים כך שהנוסחה הנתונה תניב את הערך true. 

// Set the data validation for cell A1 to equal B1 with a custom formula.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireFormulaSatisfied('=EQ(A1,B1)')
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
formulaStringנוסחה מותאמת אישית שמחזירה את הערך true אם הקלט תקין.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireNumberBetween(start, end)

הפונקציה מגדירה את כלל אימות הנתונים כך שנדרש מספר שנמצא בין שני מספרים שצוינו, או ששווה לאחד מהם. 

// Set the data validation for cell A1 to require a number between 1 and 10.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation().requireNumberBetween(1, 10).build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
startNumberהערך הנמוך ביותר שמתקבל.
endNumberהערך המקסימלי הקביל.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireNumberEqualTo(number)

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

// Set the data validation for cell A1 to require a number equal
// to 3.1415926536.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation().requireNumberEqualTo(Math.PI).build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
numberNumberהערך הקביל היחיד.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireNumberGreaterThan(number)

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

// Set the data validation for cell A1 to require a number greater than 0.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation().requireNumberGreaterThan(0).build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
numberNumberהערך הכי גבוה שלא קביל.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireNumberGreaterThanOrEqualTo(number)

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

// Set the data validation for cell A1 to require a number greater than or equal
// to 0.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireNumberGreaterThanOrEqualTo(0)
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
numberNumberהערך הנמוך ביותר שמתקבל.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireNumberLessThan(number)

מגדיר את כלל אימות הנתונים כך שיידרש מספר שקטן מהערך שצוין. 

// Set the data validation for cell A1 to require a number less than 0.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation().requireNumberLessThan(0).build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
numberNumberהערך הנמוך ביותר שלא קביל.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireNumberLessThanOrEqualTo(number)

הפונקציה מגדירה את כלל אימות הנתונים כך שיידרש מספר שקטן מהערך שצוין או שווה לו. 

// Set the data validation for cell A1 to require a number less than or equal to
// 0.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireNumberLessThanOrEqualTo(0)
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
numberNumberהערך המקסימלי הקביל.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireNumberNotBetween(start, end)

מגדיר את כלל אימות הנתונים כך שנדרש מספר שלא נמצא בין שני מספרים שצוינו, ולא שווה לאף אחד מהם. 

// Set the data validation for cell A1 to require a number not between 1 and 10.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation().requireNumberNotBetween(1, 10).build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
startNumberהערך הנמוך ביותר שלא קביל.
endNumberהערך הכי גבוה שלא קביל.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireNumberNotEqualTo(number)

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

// Set the data validation for cell A1 to require a number not equal to 0.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation().requireNumberNotEqualTo(0).build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
numberNumberהערך הלא קביל היחיד.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireTextContains(text)

מגדיר את כלל אימות הנתונים כך שהקלט יצטרך להכיל את הערך שצוין. 

// Set the data validation for cell A1 to require any value that includes
// "Google".
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation().requireTextContains('Google').build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
textStringהערך שצריך להיות בקלט.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireTextDoesNotContain(text)

מגדיר את כלל אימות הנתונים כך שהקלט לא יכיל את הערך שצוין. 

// Set the data validation for cell A1 to require any value that does not
// include "@".
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation().requireTextDoesNotContain('@').build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
textStringהערך שהקלט לא יכול להכיל.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireTextEqualTo(text)

הפונקציה מגדירה את כלל אימות הנתונים כך שהקלט יהיה שווה לערך הנתון. 

// Set the data validation for cell A1 to require "Yes".
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule =
    SpreadsheetApp.newDataValidation().requireTextEqualTo('Yes').build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
textStringהערך הקביל היחיד.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireTextIsEmail()

מגדירה את כלל אימות הנתונים כך שהקלט יהיה בפורמט של כתובת אימייל. 

// Set the data validation for cell A1 to require text in the form of an email
// address.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation().requireTextIsEmail().build();
cell.setDataValidation(rule);

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireTextIsUrl()

הגדרת כלל לאימות נתונים שדורש שהקלט יהיה בפורמט של כתובת URL. 

// Set the data validation for cell A1 to require text in the form of a URL.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation().requireTextIsUrl().build();
cell.setDataValidation(rule);

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireValueInList(values)

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

// Set the data validation for cell A1 to require "Yes" or "No", with a dropdown
// menu.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireValueInList(['Yes', 'No'])
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
valuesString[]מערך של ערכים קבילים.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireValueInList(values, showDropdown)

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

// Set the data validation for cell A1 to require "Yes" or "No", with no
// dropdown menu.
const cell = SpreadsheetApp.getActive().getRange('A1');
const rule = SpreadsheetApp.newDataValidation()
                 .requireValueInList(['Yes', 'No'], false)
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
valuesString[]מערך של ערכים קבילים.
showDropdownBoolean‫true אם בגיליון האלקטרוני צריך להופיע תפריט נפתח עם הערכים; false אם לא.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireValueInRange(range)

מגדירה את כלל אימות הנתונים כך שהקלט יהיה שווה לערך בטווח הנתון. 

// Set the data validation for cell A1 to require a value from B1:B10, with a
// dropdown menu.
const cell = SpreadsheetApp.getActive().getRange('A1');
const range = SpreadsheetApp.getActive().getRange('B1:B10');
const rule =
    SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
rangeRangeטווח שמכיל את הערכים הקבילים.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

requireValueInRange(range, showDropdown)

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

// Set the data validation for cell A1 to require value from B1:B10, with no
// dropdown menu.
const cell = SpreadsheetApp.getActive().getRange('A1');
const range = SpreadsheetApp.getActive().getRange('B1:B10');
const rule = SpreadsheetApp.newDataValidation()
                 .requireValueInRange(range, false)
                 .build();
cell.setDataValidation(rule);

פרמטרים

שםסוגתיאור
rangeRangeטווח שמכיל את הערכים הקבילים.
showDropdownBoolean‫true אם בגיליון האלקטרוני צריך להופיע תפריט נפתח עם הערכים; false אם לא.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

setAllowInvalid(allowInvalidData)

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

פרמטרים

שםסוגתיאור
allowInvalidDataBoolean‫true אם הכלל צריך לאפשר הזנה שלא עוברת את אימות הנתונים; false אם לא.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

setHelpText(helpText)

מגדיר את טקסט העזרה שמופיע כשמעבירים את העכבר מעל התא שבו מוגדר אימות נתונים.

פרמטרים

שםסוגתיאור
helpTextStringטקסט העזרה שרוצים להגדיר.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור

withCriteria(criteria, args)

מגדירה את הכלל לאימות נתונים לפי קריטריונים שמוגדרים על ידי ערכי DataValidationCriteria, בדרך כלל מתוך criteria ו-arguments של כלל קיים. 

// 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);

פרמטרים

שםסוגתיאור
criteriaDataValidationCriteriaסוג הקריטריונים לאימות הנתונים.
argsObject[]מערך של ארגומנטים שמתאימים לסוג הקריטריונים. מספר הארגומנטים והסוג שלהם תואמים לשיטה require...() המתאימה שמופיעה למעלה.

חזרה

‫DataValidationBuilder – ה-builder הזה, לשרשור