DataValidationBuilder | excol

DataValidationBuilder class.

Hierarchy

DataValidationBuilder

Index

Constructors

constructor

Constructors

constructor

new DataValidationBuilder(): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:16
Constructor

Returns DataValidationBuilder

Methods

build

build(): DataValidation

- Defined in lib/validation/DataValidationBuilder.ts:25
Returns DataValidation

requireDate

requireDate(): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:34
Sets the data-validation rule to require a date.

Returns DataValidationBuilder

requireDateAfter

requireDateAfter(date: Date): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:45
Sets the data-validation rule to require a date after the given value. The time fields of the Date object are ignored; only the day, month, and year fields are used.

Parameters
- date: Date
Returns DataValidationBuilder

requireDateBefore

requireDateBefore(date: Date): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:55
Sets the data-validation rule to require a date before the given value. The time fields of the Date object are ignored; only the day, month, and year fields are used.

Parameters
- date: Date
Returns DataValidationBuilder

requireDateBetween

requireDateBetween(start: Date, end: Date): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:68
Sets the data-validation rule to require a date between the given values, inclusive of the values themselves. The time fields of the Date objects are ignored; only the day, month, and year fields are used.

Parameters
- start: Date
- end: Date
Returns DataValidationBuilder

requireDateEqualTo

requireDateEqualTo(date: Date): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:81
Sets the data-validation rule to require a date equal to the given value. The time fields of the Date object are ignored; only the day, month, and year fields are used.

Parameters
- date: Date
Returns DataValidationBuilder

requireDateNotBetween

requireDateNotBetween(start: Date, end: Date): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:94
Sets the data-validation rule to require a date not between the given values, inclusive of the values themselves. The time fields of the Date objects are ignored; only the day, month, and year fields are used.

Parameters
- start: Date
- end: Date
Returns DataValidationBuilder

requireDateOnOrAfter

requireDateOnOrAfter(date: Date): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:107
Sets the data-validation rule to require a date on or after the given value. The time fields of the Date object are ignored; only the day, month, and year fields are used.

Parameters
- date: Date
Returns DataValidationBuilder

requireDateOnOrBefore

requireDateOnOrBefore(date: Date): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:119
Sets the data-validation rule to require a date on or before the given value. The time fields of the Date object are ignored; only the day, month, and year fields are used.

Parameters
- date: Date
Returns DataValidationBuilder

requireFormulaSatisfied

requireFormulaSatisfied(formula: string): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:130
Sets the data-validation rule to require that the given formula evaluates to true.

Parameters
- formula: string
Returns DataValidationBuilder

requireNumberBetween

requireNumberBetween(start: number, end: number): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:142
Sets the data-validation rule to require a number between the given values, inclusive of the values themselves.

Parameters
- start: number
- end: number
Returns DataValidationBuilder

requireNumberEqualTo

requireNumberEqualTo(number: number): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:154
Sets the data-validation rule to require a number equal to the given value.

Parameters
- number: number
Returns DataValidationBuilder

requireNumberGreaterThan

requireNumberGreaterThan(number: number): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:165
Sets the data-validation rule to require a number greater than the given value.

Parameters
- number: number
Returns DataValidationBuilder

requireNumberGreaterThanOrEqualTo

requireNumberGreaterThanOrEqualTo(number: number): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:176
Sets the data-validation rule to require a number greater than or equal to the given value.

Parameters
- number: number
Returns DataValidationBuilder

requireNumberLessThan

requireNumberLessThan(number: number): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:187
Sets the data-validation rule to require a number less than the given value.

Parameters
- number: number
Returns DataValidationBuilder

requireNumberLessThanOrEqualTo

requireNumberLessThanOrEqualTo(number: number): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:198
Sets the data-validation rule to require a number less than or equal to the given value.

Parameters
- number: number
Returns DataValidationBuilder

requireNumberNotBetween

requireNumberNotBetween(start: number, end: number): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:210
Sets the data-validation rule to require a number not between the given values, inclusive of the values themselves.

Parameters
- start: number
- end: number
Returns DataValidationBuilder

requireNumberNotEqualTo

requireNumberNotEqualTo(number: number): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:222
Sets the data-validation rule to require a number not equal to the given value.

Parameters
- number: number
Returns DataValidationBuilder

requireTextContains

requireTextContains(text: string): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:233
Sets the data-validation rule to require that the input contains the given value.

Parameters
- text: string
Returns DataValidationBuilder

requireTextDoesNotContain

requireTextDoesNotContain(text: string): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:244
Sets the data-validation rule to require that the input does not contain the given value.

Parameters
- text: string
Returns DataValidationBuilder

requireTextEqualTo

requireTextEqualTo(text: string): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:254
Sets the data-validation rule to require that the input is equal to the given value.

Parameters
- text: string
Returns DataValidationBuilder

requireTextIsEmail

requireTextIsEmail(): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:263
Sets the data-validation rule to require that the input is in the form of an email address.

Returns DataValidationBuilder

requireTextIsUrl

requireTextIsUrl(): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:271
Sets the data-validation rule to require that the input is in the form of a URL.

Returns DataValidationBuilder

requireValueInList

requireValueInList(values: string[], showDropdown?: undefined | true | false): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:283
Sets the data-validation rule to require that the input is equal to one of the given values.

Sets the data-validation rule to require that the input is equal to one of the given values, with an option to hide the dropdown menu.

Parameters
- values: string[]
- Optional showDropdown: undefined | true | false
Returns DataValidationBuilder

requireValueInRange

requireValueInRange(range: Range, showDropdown?: undefined | true | false): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:297
Sets the data-validation rule to require that the input is equal to a value in the given range.

Sets the data-validation rule to require that the input is equal to a value in the given range, with an option to hide the dropdown menu.

Parameters
- range: Range
- Optional showDropdown: undefined | true | false
Returns DataValidationBuilder

setAllowInvalid

setAllowInvalid(allowInvalidData: boolean): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:309
Sets whether to show a warning when input fails data validation or whether to reject the input entirely. The default for new data-validation rules is true.

Parameters
- allowInvalidData: boolean
Returns DataValidationBuilder

setHelpText

setHelpText(helpText: string): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:319
Sets the help text shown when the user hovers over the cell on which data-validation is set.

Parameters
- helpText: string
Returns DataValidationBuilder

withCriteria

withCriteria(criteria: DataValidationCriteria, args: Object[]): DataValidationBuilder

- Defined in lib/validation/DataValidationBuilder.ts:330
Sets the data-validation rule to require criteria defined in the DataValidationCriteria enum.

Parameters
- criteria: DataValidationCriteria
- args: Object[]
Returns DataValidationBuilder

Generated using TypeDoc