Skip to main content

Add

Adds data validation to the specified range.

Syntax

expression.Add(Type, AlertStyle, Operator, Formula1, Formula2);

expression - A variable that represents a ApiValidation class.

Parameters

NameRequired/OptionalData typeDefaultDescription
TypeRequiredValidationTypeThe validation type.
AlertStyleOptionalValidationAlertStyleThe validation alert style.
OperatorOptionalValidationOperatorThe data validation operator.
Formula1Optionalstring | number | ApiRangeThe first formula in the data validation.
Formula2Optionalstring | number | ApiRangeThe second formula in the data validation.

Returns

ApiValidation | null

Example

This example adds a data validation rule to a range of cells.

// How to apply data validation to a range of cells.

// Get a range from the worksheet and add data validation to it.

let worksheet = Api.GetActiveSheet();
worksheet.GetRange("A1").SetValue("Data Validation for decimal to be more than 10");
const range = worksheet.GetRange("A2:A3");
range.SetValue("10");
const validation = worksheet.GetRange("A2").GetValidation();
validation.Add("xlValidateDecimal", "xlValidAlertWarning", "xlGreater", "12");
worksheet.GetRange("A4").SetValue("Data Validation is now applied for A2 only");