/
excelscript.datavalidationtype.yml
76 lines (71 loc) · 2.82 KB
/
excelscript.datavalidationtype.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
### YamlMime:TSEnum
name: ExcelScript.DataValidationType
uid: 'ExcelScript!ExcelScript.DataValidationType:enum'
package: ExcelScript!
fullName: ExcelScript.DataValidationType
summary: Represents the data validation type enum.
remarks: |-
#### Examples
```TypeScript
/**
* This sample reads and logs the data validation type of the currently selected range.
*/
function main(workbook: ExcelScript.Workbook) {
// Get the currently selected range.
let range = workbook.getSelectedRange();
// Get the type (`DataValidationType`) of data validation applied to the range.
let validationType = range.getDataValidation().getType();
/*
* Log the data validation type.
* If the range has a single value, it logs that type.
* If the range doesn't have data validation applied, it logs "None".
* If the range has multiple different types of data validation, it logs "Inconsistent" or "MixedCriteria".
*/
console.log(validationType.toString());
}
```
isPreview: false
isDeprecated: false
fields:
- name: custom
uid: 'ExcelScript!ExcelScript.DataValidationType.custom:member'
package: ExcelScript!
summary: The custom data validation type.
- name: date
uid: 'ExcelScript!ExcelScript.DataValidationType.date:member'
package: ExcelScript!
summary: The date data validation type.
- name: decimal
uid: 'ExcelScript!ExcelScript.DataValidationType.decimal:member'
package: ExcelScript!
summary: The decimal data validation type.
- name: inconsistent
uid: 'ExcelScript!ExcelScript.DataValidationType.inconsistent:member'
package: ExcelScript!
summary: >-
Inconsistent means that the range has inconsistent data validation, indicating that there are different rules on
different cells.
- name: list
uid: 'ExcelScript!ExcelScript.DataValidationType.list:member'
package: ExcelScript!
summary: The list data validation type.
- name: mixedCriteria
uid: 'ExcelScript!ExcelScript.DataValidationType.mixedCriteria:member'
package: ExcelScript!
summary: Mixed criteria means that the range has data validation present on some but not all cells.
- name: none
uid: 'ExcelScript!ExcelScript.DataValidationType.none:member'
package: ExcelScript!
summary: 'None means allow any value, indicating that there is no data validation in the range.'
- name: textLength
uid: 'ExcelScript!ExcelScript.DataValidationType.textLength:member'
package: ExcelScript!
summary: The text length data validation type.
- name: time
uid: 'ExcelScript!ExcelScript.DataValidationType.time:member'
package: ExcelScript!
summary: The time data validation type.
- name: wholeNumber
uid: 'ExcelScript!ExcelScript.DataValidationType.wholeNumber:member'
package: ExcelScript!
summary: The whole number data validation type.