本文介绍与表格文档Validation相关的API。
Validation
Range.Validation
获取指定区域中的数据有效性规则。
语法
表达式.Range.Validation
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取区域对象 const range = await app.Range('A1'); //获取数据有效性规则 const validation = await range.Validation; }
方法
Range.Validation.Add()
通过Add()
方法,您可以新增数据有效性规则。
语法
表达式.Range.Validation.Add({ Type, Operator, Formula1, Formula2 })
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Type
Enum
是
指定要对数据进行的有效性验证类型。更多信息,请参见XlDVType。
Operator
Enum
否
数据验证运算符。更多信息,请参见XlFormatConditionOperator。
Formula1
String
否
数据验证公式中的第一部分,不得超过255个字符。
Formula2
String
否
当参数Operator取值为
xlBetween
或xlNotBetween
时,数据验证公式的第二部分,不得超过255个字符。当参数Operator取值不为
xlBetween
或xlNotBetween
时,将忽略此参数。
示例
async function example() { await instance.ready(); const app = instance.Application; //获取区域对象 const range = await app.Range('A1'); //获取数据有效性规则 const validation = await range.Validation; //添加数据有效性规则 await validation.Add({ Type: app.Enum.XlDVType.xlValidateWholeNumber, Operator: app.Enum.XlFormatConditionOperator.xlBetween, Formula1: '1', Formula2: '5', }); }
Range.Validation.Delete()
通过Delete()
方法,您可以删除数据有效性规则。
语法
表达式.Range.Validation.Delete()
表达式:文档类型应用对象
示例
async function example() { await instance.ready(); const app = instance.Application; //获取区域对象 const range = await app.Range('A1'); //获取数据有效性规则 const validation = await range.Validation; //添加数据有效性规则 await validation.Add({ Type: app.Enum.XlDVType.xlValidateWholeNumber, Operator: app.Enum.XlFormatConditionOperator.xlBetween, Formula1: '1', Formula2: '5', }); //10000 ms后删除该规则 setTimeout(async () => { await validation.Delete(); }, 10000); }
Range.Validation.Modify()
通过Modify()
方法,您可以修改数据有效性规则。
语法
表达式.Range.Validation.Modify({ Type, Operator, Formula1, Formula2 })
表达式:文档类型应用对象
参数
属性
数据类型
是否必填
描述
Type
Enum
是
指定要对数据进行的有效性验证类型。更多信息,请参见XlDVType。
Operator
Enum
否
数据验证运算符。更多信息,请参见XlFormatConditionOperator。
Formula1
String
否
数据验证公式中的第一部分,不得超过255个字符。
Formula2
String
否
当参数Operator取值为
xlBetween
或xlNotBetween
时,数据验证公式的第二部分,不得超过255个字符。当参数Operator取值不为
xlBetween
或xlNotBetween
时,将忽略此参数。
示例
async function example() { await instance.ready(); const app = instance.Application; //获取区域对象 const range = await app.Range('A1'); //获取数据有效性规则 const validation = await range.Validation; //添加数据有效性规则 await validation.Add({ Type: app.Enum.XlDVType.xlValidateWholeNumber, Operator: app.Enum.XlFormatConditionOperator.xlBetween, Formula1: '1', Formula2: '5', }); //10000 ms后修改该规则 setTimeout(async () => { await validation.Modify({ Type: app.Enum.XlDVType.xlValidateWholeNumber, Operator: app.Enum.XlFormatConditionOperator.xlNotBetween, Formula1: '1', Formula2: '5', }); }, 10000); }