資料驗證規則的建構工具。
// 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);
方法
內容詳盡的說明文件
build()
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()。如要使用這些值建立或修改資料驗證規則,請參閱 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[]:適用於規則條件類型的一組引數;引數數量和類型與 DataValidationBuilder 類別的對應 require...() 方法相符
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 - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
checked | Object | 指派給核取方塊的值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
checked | Object | 指派給核取方塊的值。 |
unchecked | Object | 指派給未勾選方塊的值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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 - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | Date | 最晚可接受的日期。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | Date | 最早的不可接受日期。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
start | Date | 最早可接受的日期。 |
end | Date | 最晚可接受的日期。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | Date | 這是唯一可接受的日期。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
start | Date | 最早的不可接受日期。 |
end | Date | 最晚可接受的日期。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | Date | 最早可接受的日期。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
date | Date | 最晚可接受的日期。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
formula | String | 如果輸入內容有效,自訂公式的評估結果為 true。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
start | Number | 可接受的最低值。 |
end | Number | 可接受的最高價值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 唯一可接受的值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 最高不可接受的值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 可接受的最低值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 最低不可接受的值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 可接受的最高價值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
start | Number | 最低不可接受的值。 |
end | Number | 最高不可接受的值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
number | Number | 唯一不接受的值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
text | String | 輸入內容必須包含的值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
text | String | 輸入內容不得包含的值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
text | String | 唯一可接受的值。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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 - 這個建構工具,用於鏈結
requireTextIsUrl()
設定資料驗證規則,規定輸入內容必須是網址。
// 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 - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
values | String[] | 可接受的值陣列。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
values | String[] | 可接受的值陣列。 |
show | Boolean | true (試算表是否應顯示值下拉式選單);false (否)。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
range | Range | 包含可接受值的範圍。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
range | Range | 包含可接受值的範圍。 |
show | Boolean | true (試算表是否應顯示值下拉式選單);false (否)。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
setAllowInvalid(allowInvalidData)
設定輸入內容未通過資料驗證時,是否要顯示警告或完全拒絕輸入。新資料驗證規則的預設值為 true。
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
allow | Boolean | true 如果規則應允許輸入未通過資料驗證的內容;
false 如果不允許。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
setHelpText(helpText)
設定使用者將滑鼠游標懸停在已設定資料驗證的儲存格上時,顯示的說明文字。
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
help | String | 要設定的說明文字。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結
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);
參數
| 名稱 | 類型 | 說明 |
|---|---|---|
criteria | Data | 資料驗證條件的類型。 |
args | Object[] | 符合條件類型的一組引數;引數數量和引數類型與上述對應的 require...() 方法相符。 |
回攻員
DataValidationBuilder - 這個建構工具,用於鏈結