Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Excel.DataValidationAlertStyle enum

Package:
excel

Represents the data validation error alert style. The default is Stop.

Remarks

API set: ExcelApi 1.8

Used by

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml

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

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

 let greaterThanZeroRule = {
 wholeNumber: {
 formula1: 0,
 operator: Excel.DataValidationOperator.greaterThan
 }
 };
 rankingRange.dataValidation.rule = greaterThanZeroRule;

 rankingRange.dataValidation.prompt = {
 message: "Please enter a positive number.",
 showPrompt: true,
 title: "Positive numbers only."
 };

 rankingRange.dataValidation.errorAlert = {
 message: "Sorry, only positive numbers are allowed",
 showAlert: true,
 style: Excel.DataValidationAlertStyle.stop,
 title: "Negative Number Entered"
 };

 await context.sync();
});

Fields

information = "Information"
stop = "Stop"
warning = "Warning"

Feedback

Was this page helpful?