数据验证规则的构建器。
// Set the data validation for cell A1 to require a value from B1:B10. var cell = SpreadsheetApp.getActive().getRange('A1'); var range = SpreadsheetApp.getActive().getRange('B1:B10'); var 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. 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()
获取 DataValidationCriteria
枚举中定义的规则条件类型。要获取
条件参数,请使用 getCriteriaValues()
。要使用这些值来创建或
修改数据验证规则,请参阅 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()
。如需使用这些值创建或修改数据验证规则,请参阅 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[]
- 适用于规则的条件类型的参数数组;参数数量
并且其类型与 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireCheckbox('APPROVED').build(); cell.setDataValidation(rule);
参数
名称 | 类型 | 说明 |
---|---|---|
checkedValue | 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireCheckbox('APPROVED', 'PENDING').build(); cell.setDataValidation(rule);
参数
名称 | 类型 | 说明 |
---|---|---|
checkedValue | Object | 分配给所选复选框的值。 |
uncheckedValue | Object | 分配给未选中框的值。 |
返回
DataValidationBuilder
- 此构建器,用于链接
requireDate()
将数据验证规则设置为要求指定日期。
// Set the data validation for cell A1 to require a date. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireFormulaSatisfied('=EQ(A1,B1)').build(); cell.setDataValidation(rule);
参数
名称 | 类型 | 说明 |
---|---|---|
formula | String | 计算结果为 true (如果输入有效)的自定义公式。 |
返回
DataValidationBuilder
- 此构建器,用于链接
requireNumberBetween(start, end)
将数据验证规则设置为要求输入介于 2 或 2 之间的数字 。
// Set the data validation for cell A1 to require a number between 1 and 10. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireNumberEqualTo(3.1415926536).build(); cell.setDataValidation(rule);
参数
名称 | 类型 | 说明 |
---|---|---|
number | Number | 唯一可接受的值。 |
返回
DataValidationBuilder
- 此构建器,用于链接
requireNumberGreaterThan(number)
将数据验证规则设置为要求大于指定值的数字。
// Set the data validation for cell A1 to require a number greater than 0. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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". var cell = SpreadsheetApp.getActive().getRange('A1'); var 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 "@". var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireTextDoesNotContain('@').build(); cell.setDataValidation(rule);
参数
名称 | 类型 | 说明 |
---|---|---|
text | String | 输入中不能包含的值。 |
返回
DataValidationBuilder
- 此构建器,用于链接
requireTextEqualTo(text)
设置数据验证规则,要求输入等于指定值。
// Set the data validation for cell A1 to require "Yes". var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = SpreadsheetApp.newDataValidation().requireValueInList(['Yes', 'No'], false).build(); cell.setDataValidation(rule);
参数
名称 | 类型 | 说明 |
---|---|---|
values | String[] | 可接受的值数组。 |
showDropdown | Boolean | 如果电子表格应显示值的下拉菜单,则为 true ;
如果不是,则为 false 。 |
返回
DataValidationBuilder
- 此构建器,用于链接
requireValueInRange(range)
设置数据验证规则,要求输入值等于指定范围内的值。
// Set the data validation for cell A1 to require a value from B1:B10, with a dropdown menu. var cell = SpreadsheetApp.getActive().getRange('A1'); var range = SpreadsheetApp.getActive().getRange('B1:B10'); var 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. var cell = SpreadsheetApp.getActive().getRange('A1'); var range = SpreadsheetApp.getActive().getRange('B1:B10'); var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range, false).build(); cell.setDataValidation(rule);
参数
名称 | 类型 | 说明 |
---|---|---|
range | Range | 包含可接受值的范围。 |
showDropdown | Boolean | 如果电子表格应显示值的下拉菜单,则为 true ;
如果不是,则为 false 。 |
返回
DataValidationBuilder
- 此构建器,用于链接
setAllowInvalid(allowInvalidData)
设置是否在输入数据验证失败时显示警告或是否拒绝输入
新数据验证规则的默认值为 true
。
参数
名称 | 类型 | 说明 |
---|---|---|
allowInvalidData | Boolean | 如果规则应允许未通过数据验证的输入,则为 true ;
如果不是,则为 false 。 |
返回
DataValidationBuilder
- 此构建器,用于链接
setHelpText(helpText)
设置当用户将鼠标悬停在进行数据验证的单元格上时显示的帮助文本 。
参数
名称 | 类型 | 说明 |
---|---|---|
helpText | 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. 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);
参数
名称 | 类型 | 说明 |
---|---|---|
criteria | DataValidationCriteria | 数据验证条件的类型。 |
args | Object[] | 适合条件类型的参数数组;参数数量
其类型与上面相应的 require...() 方法匹配。 |
返回
DataValidationBuilder
- 此构建器,用于链接