| Components | All | New | MacOS | Windows | Linux | iOS | ||||
| Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old | |
XL.Sheet.DataValidations
Queries details on all data validations.
| Component | Version | macOS | Windows | Linux | Server | iOS SDK |
| XL | 16.3 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "XL.Sheet.DataValidations"; BookRef; SheetIndex ) More
Parameters
| Parameter | Description | Example |
|---|---|---|
| BookRef | The reference number for the workbook. | $ref |
| SheetIndex | The index of the sheet. This number ranges from 0 to XL.Book.SheetCount-1. | 0 |
Result
Returns JSON or error.
Description
Queries details on all data validations.Returns a JSON array with the details.
| Name | Description |
|---|---|
| index | the index of data validation; |
| type | the type of data validation; |
| op | the relational operator of data validation; |
| rowFirst | the first row of range; |
| rowLast | the last row of range; |
| colFirst | the first column of range; |
| colLast | the last column of range; |
| value1 | the first value for relational operator; |
| value2 | the second value for VALIDATION_OP_BETWEEN = 0 or VALIDATION_OP_NOTBETWEEN = 1 operator; |
| allowBlank | a boolean value indicating whether the data validation treats empty or blank entries as valid, 'true' means empty entries are OK and do not violate the validation constraints; |
| hideDropDown | a boolean value indicating whether to display the dropdown combo box for a list type data validation (VALIDATION_TYPE_LIST = 3); |
| showInputMessage | a boolean value indicating whether to display the input prompt message; |
| showErrorMessage | a boolean value indicating whether to display the error alert message when an invalid value has been entered, according to the criteria specified; |
| promptTitle | title bar text of input prompt; |
| prompt | message text of input prompt; |
| errorTitle | title bar text of error alert; |
| error | message text of error alert; |
| errorStyle | the style of error alert used for this data validation. |
See also
- XL.Book.SheetCount
- XL.Sheet.AddDataValidation
- XL.Sheet.DataValidation
- XL.Sheet.DataValidationSize
- XL.Sheet.RemoveDataValidations
Release notes
- Version 16.3
- Added XL.Sheet.DataValidation, XL.Sheet.DataValidationSize and XL.Sheet.DataValidations functions.
This function checks for a license.
Created 21st May 2026, last changed 21st May 2026
