Excel.DataValidation class

表示应用于当前范围的数据验证。Represents the data validation applied to the current range.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

Extends

属性

context

与该对象关联的请求上下文。The request context associated with the object. 这会将加载项的进程连接到 Office 主机应用程序的进程。This connects the add-in's process to the Office host application's process.

errorAlert

用户输入无效数据时,出现错误警报。Error alert when user enters invalid data.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

ignoreBlanks

忽略空白:不会对空白单元格执行数据严重,默认为 true。Ignore blanks: no data validation will be performed on blank cells, it defaults to true.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

prompt

当用户选择单元格时提示。Prompt when users select a cell.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

rule

包含不同类型的数据验证条件的数据有效性规则。Data validation rule that contains different type of data validation criteria.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

type

数据有效性类型,有关详细信息,请参阅 Excel.DataValidationType。Type of the data validation, see Excel.DataValidationType for details.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

valid

表示所有单元格值根据数据有效性规则是否全部有效。Represents if all cell values are valid according to the data validation rules. 如果所有单元格的值都有效, 则返回 true; 如果所有单元格值无效, 则返回 false。Returns true if all cell values are valid, or false if all cell values are invalid. 如果区域中存在有效和无效的单元格值, 则返回 null。Returns null if there are both valid and invalid cell values within the range.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

方法

clear()

清除当前区域中的数据有效性。Clears the data validation from the current range.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

getInvalidCells()

返回包含一个或多个矩形区域的 RangeAreas,它具有无效单元格值。Returns a RangeAreas, comprising one or more rectangular ranges, with invalid cell values. 如果所有单元格值都有效,则此函数将引发 ItemNotFound 错误。If all cell values are valid, this function will throw an ItemNotFound error.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

getInvalidCellsOrNullObject()

返回包含一个或多个矩形区域的 RangeAreas,它具有无效单元格值。Returns a RangeAreas, comprising one or more rectangular ranges, with invalid cell values. 如果所有单元格值都有效,则此函数将返回 null。If all cell values are valid, this function will return null.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

load(option)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性之前,你必须调用“context.sync()”。You must call "context.sync()" before reading the properties.

load(propertyNames)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

set(properties, options)

同时设置一个对象的多个属性。Sets multiple properties of an object at the same time. 您可以传递具有相应属性的纯对象或相同类型的其他 API 对象。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties)

基于现有加载的对象同时设置该对象的多个属性。Sets multiple properties on the object at the same time, based on an existing loaded object.

toJSON()

重写 JavaScript toJSON()方法, 以便在将 API 对象传递到时提供更有用的输出JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify反过来, 也会调用传递toJSON给它的对象的方法。尽管原始 DataValidation 对象是 API 对象, 但toJSON方法返回一个无格式的 JavaScript 对象 (类型为Excel.Interfaces.DataValidationData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.DataValidation object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DataValidationData), 其中包含原始对象中所有已加载的子属性的浅表副本。) that contains shallow copies of any loaded child properties from the original object.

属性详细信息

context

与该对象关联的请求上下文。The request context associated with the object. 这会将加载项的进程连接到 Office 主机应用程序的进程。This connects the add-in's process to the Office host application's process.

context: RequestContext;

属性值

RequestContext

errorAlert

用户输入无效数据时,出现错误警报。Error alert when user enters invalid data.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

errorAlert: Excel.DataValidationErrorAlert;

属性值

示例Examples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Decision");
    const commentsRange = 
        sheet.tables.getItem("NameOptionsTable").columns.getItem("Comments").getDataBodyRange();

    // When you are developing, it is a good practice to
    // clear the dataValidation object with each run of your code.
    commentsRange.dataValidation.clear();   

    // If the value of A2 is contained in the value of C2, then 
    // SEARCH(A2,C2) returns the number where it begins. Otherwise,
    // it does not return a number.
    let redundantStringRule = {
        custom: {
            formula: "=NOT(ISNUMBER(SEARCH(A2,C2)))"
        }
    };
    commentsRange.dataValidation.rule = redundantStringRule;
    commentsRange.dataValidation.errorAlert = {
        message: "It is redundant to include the baby name in the comment.",
        showAlert: true,
        style: "Information",
        title: "Baby Name in Comment"
    };

    await context.sync();
});

ignoreBlanks

忽略空白:不会对空白单元格执行数据严重,默认为 true。Ignore blanks: no data validation will be performed on blank cells, it defaults to true.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

ignoreBlanks: boolean;

属性值

boolean

prompt

当用户选择单元格时提示。Prompt when users select a cell.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

prompt: Excel.DataValidationPrompt;

属性值

rule

包含不同类型的数据验证条件的数据有效性规则。Data validation rule that contains different type of data validation criteria.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

rule: Excel.DataValidationRule;

属性值

type

数据有效性类型,有关详细信息,请参阅 Excel.DataValidationType。Type of the data validation, see Excel.DataValidationType for details.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

readonly type: Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria";

属性值

Excel.DataValidationType | "None" | "WholeNumber" | "Decimal" | "List" | "Date" | "Time" | "TextLength" | "Custom" | "Inconsistent" | "MixedCriteria"

valid

表示所有单元格值根据数据有效性规则是否全部有效。Represents if all cell values are valid according to the data validation rules. 如果所有单元格的值都有效, 则返回 true; 如果所有单元格值无效, 则返回 false。Returns true if all cell values are valid, or false if all cell values are invalid. 如果区域中存在有效和无效的单元格值, 则返回 null。Returns null if there are both valid and invalid cell values within the range.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

readonly valid: boolean;

属性值

boolean

方法详细信息

clear()

清除当前区域中的数据有效性。Clears the data validation from the current range.

[API 集: ExcelApi 1.8][ API set: ExcelApi 1.8 ]

clear(): void;

返回

void

getInvalidCells()

返回包含一个或多个矩形区域的 RangeAreas,它具有无效单元格值。Returns a RangeAreas, comprising one or more rectangular ranges, with invalid cell values. 如果所有单元格值都有效,则此函数将引发 ItemNotFound 错误。If all cell values are valid, this function will throw an ItemNotFound error.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

getInvalidCells(): Excel.RangeAreas;

返回

getInvalidCellsOrNullObject()

返回包含一个或多个矩形区域的 RangeAreas,它具有无效单元格值。Returns a RangeAreas, comprising one or more rectangular ranges, with invalid cell values. 如果所有单元格值都有效,则此函数将返回 null。If all cell values are valid, this function will return null.

[API 集: ExcelApi 1.9][ API set: ExcelApi 1.9 ]

getInvalidCellsOrNullObject(): Excel.RangeAreas;

返回

load(option)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性之前,你必须调用“context.sync()”。You must call "context.sync()" before reading the properties.

load(option?: Excel.Interfaces.DataValidationLoadOptions): Excel.DataValidation;

参数

返回

注解

除了此签名之外, 此方法还具有以下签名:In addition to this signature, this method has the following signatures:

load(option?: string | string[]): Excel.DataValidation-Where 选项是一个逗号分隔的字符串或一个字符串数组, 用于指定要加载的属性。load(option?: string | string[]): Excel.DataValidation - Where option is a comma-delimited string or an array of strings that specify the properties to load.

load(option?: { select?: string; expand?: string; }): Excel.DataValidation-Where 选项。选择是一个用逗号分隔的字符串, 用于指定要加载的属性和选项。 expand 是一个用逗号分隔的字符串, 用于指定要加载的导航属性。load(option?: { select?: string; expand?: string; }): Excel.DataValidation - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataValidation-仅适用于集合类型。load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Excel.DataValidation - Only available on collection types. 它类似于前面的签名。It is similar to the preceding signature. Top 指定结果中可包含的集合项的最大数量。Option.top specifies the maximum number of collection items that can be included in the result. 选项。 skip 指定要跳过且不包含在结果中的项目数。Option.skip specifies the number of items that are to be skipped and not included in the result. 如果指定了 top 选项, 则在跳过指定数目的项目后将启动结果集。If option.top is specified, the result set will start after skipping the specified number of items.

load(propertyNames)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Excel.DataValidation;

参数

propertyNames
string | string[]

一个以逗号分隔的字符串或字符串数组, 用于指定要加载的属性。A comma-delimited string or an array of strings that specify the properties to load.

返回

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。Queues up a command to load the specified properties of the object. 在读取属性context.sync()之前, 必须先调用。You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: { select?: string; expand?: string; }): Excel.DataValidation;

参数

propertyNamesAndPaths
{ select?: string; expand?: string; }

其中, propertyNamesAndPaths 是用逗号分隔的字符串, 用于指定要加载的属性和 propertyNamesAndPaths。扩展是一个用逗号分隔的字符串, 用于指定要加载的导航属性。Where propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

返回

set(properties, options)

同时设置一个对象的多个属性。Sets multiple properties of an object at the same time. 您可以传递具有相应属性的纯对象或相同类型的其他 API 对象。You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.DataValidationUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Interfaces.DataValidationUpdateData

一个 JavaScript 对象, 其属性的结构 isomorphically 为在其上调用方法的对象的属性。A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options
OfficeExtension.UpdateOptions

提供一个选项, 以在 properties 对象尝试设置任何只读属性时禁止显示错误。Provides an option to suppress errors if the properties object tries to set any read-only properties.

返回

void

注解

此方法具有以下附加签名:This method has the following additional signature:

set(properties: Excel.DataValidation): void

set(properties)

基于现有加载的对象同时设置该对象的多个属性。Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.DataValidation): void;

参数

返回

void

toJSON()

重写 JavaScript toJSON()方法, 以便在将 API 对象传递到时提供更有用的输出JSON.stringify()Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify反过来, 也会调用传递toJSON给它的对象的方法。尽管原始 DataValidation 对象是 API 对象, 但toJSON方法返回一个无格式的 JavaScript 对象 (类型为Excel.Interfaces.DataValidationData, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.DataValidation object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DataValidationData), 其中包含原始对象中所有已加载的子属性的浅表副本。) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.DataValidationData;

返回