FDataValidationBuilder

packages	`@univerjs/sheets-data-validation`

Builder for data validation rules. use FUniver univerAPI.newDataValidation() to create a new builder.

Examples

// Set the data validation for cell A1 to require a value from B1:B10
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('B1:B2')
fRange.setValues([
  ['Yes'],
  ['No'],
])

const rule = univerAPI.newDataValidation()
  .requireValueInRange(fRange)
  .setOptions({
    allowBlank: false,
    showErrorMessage: true,
    error: 'Please enter a value from the list',
  })
  .build()
const cell = fWorksheet.getRange('A1')
cell.setDataValidation(rule)

APIs

`build`

Builds an FDataValidation instance based on the _rule property of the current class

Signature

build(): FDataValidation

Returns

(FDataValidation) — A new instance of the FDataValidation class

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number between 1 and 10 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberBetween(1, 10)
  .setOptions({
    allowBlank: true,
    showErrorMessage: true,
    error: 'Please enter a number between 1 and 10',
  })
  .build()
fRange.setDataValidation(rule)

`copy`

Creates a duplicate of the current DataValidationBuilder object

Signature

copy(): FDataValidationBuilder

Returns

(FDataValidationBuilder) — A new instance of the DataValidationBuilder class

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number between 1 and 10 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const builder = univerAPI.newDataValidation()
  .requireNumberBetween(1, 10)
  .setOptions({
    allowBlank: true,
    showErrorMessage: true,
    error: 'Please enter a number between 1 and 10',
  })
fRange.setDataValidation(builder.build())

// Copy the builder applied to the new range F1:G10
const newRange = fWorksheet.getRange('F1:G10')
const copyBuilder = builder.copy()
newRange.setDataValidation(copyBuilder.build())

`getAllowInvalid`

Determines whether invalid data is allowed

Signature

getAllowInvalid(): boolean

Returns

(boolean) — True if invalid data is allowed, False otherwise

Examples

const builder = univerAPI.newDataValidation().requireNumberBetween(1, 10)
console.log(builder.getAllowInvalid())

`getCriteriaType`

Gets the data validation type of the rule

Signature

getCriteriaType(): DataValidationType | string

Returns

(DataValidationType | string) — The data validation type

Examples

const builder = univerAPI.newDataValidation()
console.log(builder.getCriteriaType()) // custom

builder.requireNumberBetween(1, 10)
console.log(builder.getCriteriaType()) // decimal

builder.requireValueInList(['Yes', 'No'])
console.log(builder.getCriteriaType()) // list

`getCriteriaValues`

Gets the values used for criteria evaluation

Signature

getCriteriaValues(): [string | undefined, string | undefined, string | undefined]

Returns

([string | undefined, string | undefined, string | undefined]) — An array containing the operator, formula1, and formula2 values

Examples

const builder = univerAPI.newDataValidation().requireNumberBetween(1, 10)
const [operator, formula1, formula2] = builder.getCriteriaValues()
console.log(operator, formula1, formula2) // between 1 10

builder.requireValueInList(['Yes', 'No'])
console.log(builder.getCriteriaValues()) // undefined Yes,No undefined

`getHelpText`

Gets the help text information, which is used to provide users with guidance and support

Signature

getHelpText(): string | undefined

Returns

(string | undefined) — Returns the help text information. If there is no error message, it returns an undefined value

Examples

const builder = univerAPI.newDataValidation().setOptions({
  showErrorMessage: true,
  error: 'Please enter a valid value',
})
console.log(builder.getHelpText()) // 'Please enter a valid value'

`requireCheckbox`

Sets the data validation rule to require that the input is a boolean value; this value is rendered as a checkbox.

Signature

requireCheckbox(checkedValue?: string, uncheckedValue?: string): FDataValidationBuilder

Parameters

checkedValue (string) — - The value assigned to a checked box.
uncheckedValue (string) — - The value assigned to an unchecked box.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set the data validation for cell A1:A10 to require a checkbox with default 1 and 0 values
const fRange = fWorksheet.getRange('A1:A10')
const rule = univerAPI.newDataValidation()
  .requireCheckbox()
  .build()
fRange.setDataValidation(rule)

// Set the data validation for cell B1:B10 to require a checkbox with 'Yes' and 'No' values
const fRange2 = fWorksheet.getRange('B1:B10')
const rule2 = univerAPI.newDataValidation()
  .requireCheckbox('Yes', 'No')
  .build()
fRange2.setDataValidation(rule2)

`requireDateAfter`

Set the data validation type to DATE and configure the validation rules to be after a specific date.

Signature

requireDateAfter(date: Date): FDataValidationBuilder

Parameters

date (Date) — - The latest unacceptable date.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set some date values in the range A1:B2
const fRange = fWorksheet.getRange('A1:B2')
fRange.setValues([
  ['2024-01-01', '2024-12-31'],
  ['2025-01-01', '2025-12-31'],
])

// Create a data validation rule that requires a date after 2025-01-01
const rule = univerAPI.newDataValidation()
  .requireDateAfter(new Date('2025-01-01'))
  .build()
fRange.setDataValidation(rule)

// Get the validation status of the range
const status = await fRange.getValidatorStatus()
console.log(status) // [['invalid', 'invalid', 'invalid', 'valid']]

`requireDateBefore`

Set the data validation type to DATE and configure the validation rules to be before a specific date.

Signature

requireDateBefore(date: Date): FDataValidationBuilder

Parameters

date (Date) — - The earliest unacceptable date.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set some date values in the range A1:B2
const fRange = fWorksheet.getRange('A1:B2')
fRange.setValues([
  ['2024-01-01', '2024-12-31'],
  ['2025-01-01', '2025-12-31'],
])

// Create a data validation rule that requires a date before 2025-01-01
const rule = univerAPI.newDataValidation()
  .requireDateBefore(new Date('2025-01-01'))
  .build()
fRange.setDataValidation(rule)

// Get the validation status of the range
const status = await fRange.getValidatorStatus()
console.log(status) // [['valid', 'valid', 'invalid', 'invalid']]

`requireDateBetween`

Set the data validation type to DATE and configure the validation rules to be within a specific date range.

Signature

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

Parameters

start (Date) — - The earliest acceptable date.
end (Date) — - The latest acceptable date.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set some date values in the range A1:B2
const fRange = fWorksheet.getRange('A1:B2')
fRange.setValues([
  ['2024-01-01', '2024-12-31'],
  ['2025-01-01', '2025-12-31'],
])

// Create a data validation rule that requires a date between 2024-06-01 and 2025-06-01
const rule = univerAPI.newDataValidation()
  .requireDateBetween(new Date('2024-06-01'), new Date('2025-06-01'))
  .build()
fRange.setDataValidation(rule)

// Get the validation status of the range
const status = await fRange.getValidatorStatus()
console.log(status) // [['invalid', 'valid', 'valid', 'invalid']]

`requireDateEqualTo`

Set the data validation type to DATE and configure the validation rules to be equal to a specific date.

Signature

requireDateEqualTo(date: Date): FDataValidationBuilder

Parameters

date (Date) — - The sole acceptable date.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set some date values in the range A1:B2
const fRange = fWorksheet.getRange('A1:B2')
fRange.setValues([
  ['2024-01-01', '2024-12-31'],
  ['2025-01-01', '2025-12-31'],
])

// Create a data validation rule that requires a date equal to 2025-01-01
const rule = univerAPI.newDataValidation()
  .requireDateEqualTo(new Date('2025-01-01'))
  .build()
fRange.setDataValidation(rule)

// Get the validation status of the cell A2
const status = await fWorksheet.getRange('A2').getValidatorStatus()
console.log(status?.[0]?.[0]) // 'valid'

// Get the validation status of the cell B2
const status2 = await fWorksheet.getRange('B2').getValidatorStatus()
console.log(status2?.[0]?.[0]) // 'invalid'

`requireDateNotBetween`

Set the data validation type to DATE and configure the validation rules to be not within a specific date range.

Signature

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

Parameters

start (Date) — - The earliest unacceptable date.
end (Date) — - The latest unacceptable date.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set some date values in the range A1:B2
const fRange = fWorksheet.getRange('A1:B2')
fRange.setValues([
  ['2024-01-01', '2024-12-31'],
  ['2025-01-01', '2025-12-31'],
])

// Create a data validation rule that requires a date not between 2024-06-01 and 2025-06-01
const rule = univerAPI.newDataValidation()
  .requireDateNotBetween(new Date('2024-06-01'), new Date('2025-06-01'))
  .build()
fRange.setDataValidation(rule)

// Get the validation status of the range
const status = await fRange.getValidatorStatus()
console.log(status) // [['valid', 'invalid', 'invalid', 'valid']]

`requireDateOnOrAfter`

Set the data validation type to DATE and configure the validation rules to be on or after a specific date.

Signature

requireDateOnOrAfter(date: Date): FDataValidationBuilder

Parameters

date (Date) — - The earliest acceptable date.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set some date values in the range A1:B2
const fRange = fWorksheet.getRange('A1:B2')
fRange.setValues([
  ['2024-01-01', '2024-12-31'],
  ['2025-01-01', '2025-12-31'],
])

// Create a data validation rule that requires a date on or after 2025-01-01
const rule = univerAPI.newDataValidation()
  .requireDateOnOrAfter(new Date('2025-01-01'))
  .build()
fRange.setDataValidation(rule)

// Get the validation status of the range
const status = await fRange.getValidatorStatus()
console.log(status) // [['invalid', 'invalid', 'valid', 'valid']]

`requireDateOnOrBefore`

Set the data validation type to DATE and configure the validation rules to be on or before a specific date.

Signature

requireDateOnOrBefore(date: Date): FDataValidationBuilder

Parameters

date (Date) — - The latest acceptable date.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set some date values in the range A1:B2
const fRange = fWorksheet.getRange('A1:B2')
fRange.setValues([
  ['2024-01-01', '2024-12-31'],
  ['2025-01-01', '2025-12-31'],
])

// Create a data validation rule that requires a date on or before 2025-01-01
const rule = univerAPI.newDataValidation()
  .requireDateOnOrBefore(new Date('2025-01-01'))
  .build()
fRange.setDataValidation(rule)

// Get the validation status of the range
const status = await fRange.getValidatorStatus()
console.log(status) // [['valid', 'valid', 'valid', 'invalid']]

`requireFormulaSatisfied`

Sets the data validation rule to require that the given formula evaluates to true.

Signature

requireFormulaSatisfied(formula: string): FDataValidationBuilder

Parameters

formula (string) — - The formula string that needs to be satisfied, formula result should be TRUE or FALSE, and references range will relative offset.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set some values in the range A1:B2 and C1:D2
const cell = fWorksheet.getRange('A1:B2')
cell.setValues([
  [4, 3],
  [2, 1],
])
const fRange = fWorksheet.getRange('C1:D2')
fRange.setValues([
  [1, 2],
  [3, 4],
])

// Create a data validation rule that requires the formula '=A1>2' to be satisfied
const rule = univerAPI.newDataValidation()
  .requireFormulaSatisfied('=A1>2')
  .setOptions({
    showErrorMessage: true,
    error: 'Please enter a value equal to A1',
  })
  .build()
fRange.setDataValidation(rule)

// Get the validation status of the range
const status = await fRange.getValidatorStatus()
console.log(status) // [['valid', 'valid', 'invalid', 'invalid']]

`requireNumberBetween`

Sets the data validation rule to require a number that falls between, or is either of, two specified numbers.

Signature

requireNumberBetween(start: number, end: number, isInteger?: boolean): FDataValidationBuilder

Parameters

start (number) — - The lowest acceptable value.
end (number) — - The highest acceptable value.
isInteger (boolean) — - Indicates whether the required number is an integer.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number between 1 and 10 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberBetween(1, 10)
  .setOptions({
    allowBlank: false,
    showErrorMessage: true,
    error: 'Please enter a number between 1 and 10',
  })
  .build()
fRange.setDataValidation(rule)

`requireNumberEqualTo`

Sets the data validation rule to require a number equal to the given value.

Signature

requireNumberEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder

Parameters

num (number) — - The sole acceptable value.
isInteger (boolean) — - Indicates whether the required number is an integer.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number equal to 10 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberEqualTo(10)
  .setOptions({
    allowBlank: false,
    showErrorMessage: true,
    error: 'Please enter a number equal to 10',
  })
  .build()
fRange.setDataValidation(rule)

`requireNumberGreaterThan`

Sets the data validation rule to require a number greater than the given value.

Signature

requireNumberGreaterThan(num: number, isInteger?: boolean): FDataValidationBuilder

Parameters

num (number) — - The highest unacceptable value.
isInteger (boolean) — - Indicates whether the required number is an integer.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number greater than 10 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberGreaterThan(10)
  .setOptions({
    allowBlank: false,
    showErrorMessage: true,
    error: 'Please enter a number greater than 10',
  })
  .build()
fRange.setDataValidation(rule)

`requireNumberGreaterThanOrEqualTo`

Sets the data validation rule to require a number greater than or equal to the given value.

Signature

requireNumberGreaterThanOrEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder

Parameters

num (number) — - The lowest acceptable value.
isInteger (boolean) — - Indicates whether the required number is an integer.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number greater than 10 or equal to 10 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberGreaterThanOrEqualTo(10)
  .setOptions({
    allowBlank: false,
    showErrorMessage: true,
    error: 'Please enter a number greater than 10 or equal to 10',
  })
  .build()
fRange.setDataValidation(rule)

`requireNumberLessThan`

Sets the data validation rule to require a number less than the given value.

Signature

requireNumberLessThan(num: number, isInteger?: boolean): FDataValidationBuilder

Parameters

num (number) — - The lowest unacceptable value.
isInteger (boolean) — - Indicates whether the required number is an integer.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number less than 10 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberLessThan(10)
  .setOptions({
    allowBlank: false,
    showErrorMessage: true,
    error: 'Please enter a number less than 10',
  })
  .build()
fRange.setDataValidation(rule)

`requireNumberLessThanOrEqualTo`

Sets the data validation rule to require a number less than or equal to the given value.

Signature

requireNumberLessThanOrEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder

Parameters

num (number) — - The highest acceptable value.
isInteger (boolean) — - Indicates whether the required number is an integer.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number less than 10 or equal to 10 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberLessThanOrEqualTo(10)
  .setOptions({
    allowBlank: false,
    showErrorMessage: true,
    error: 'Please enter a number less than 10 or equal to 10',
  })
  .build()
fRange.setDataValidation(rule)

`requireNumberNotBetween`

Sets the data validation rule to require a number that does not fall between, and is neither of, two specified numbers.

Signature

requireNumberNotBetween(start: number, end: number, isInteger?: boolean): FDataValidationBuilder

Parameters

start (number) — - The lowest unacceptable value.
end (number) — - The highest unacceptable value.
isInteger (boolean) — - Optional parameter, indicating whether the number to be verified is an integer.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number not between 1 and 10 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberNotBetween(1, 10)
  .setOptions({
    allowBlank: false,
    showErrorMessage: true,
    error: 'Please enter a number not between 1 and 10',
  })
  .build()
fRange.setDataValidation(rule)

`requireNumberNotEqualTo`

Sets the data validation rule to require a number not equal to the given value.

Signature

requireNumberNotEqualTo(num: number, isInteger?: boolean): FDataValidationBuilder

Parameters

num (number) — - The sole unacceptable value.
isInteger (boolean) — - Indicates whether the required number is an integer.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires a number not equal to 10 for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireNumberNotEqualTo(10)
  .setOptions({
    allowBlank: false,
    showErrorMessage: true,
    error: 'Please enter a number not equal to 10',
  })
  .build()
fRange.setDataValidation(rule)

Sets a data validation rule that requires the user to enter a value from a list of specific values. The list can be displayed in a dropdown, and the user can choose multiple values according to the settings.

Signature

requireValueInList(values: string[], multiple?: boolean, showDropdown?: boolean): FDataValidationBuilder

Parameters

values (string[]) — - An array of acceptable values.
multiple (boolean) — - Optional parameter indicating whether the user can select multiple values.
showDropdown (boolean) — - Optional parameter indicating whether to display the list in a dropdown.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires the user to enter a value from the list ['Yes', 'No'] for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireValueInList(['Yes', 'No'])
  .setOptions({
    allowBlank: true,
    showErrorMessage: true,
    error: 'Please enter a value from the list',
  })
  .build()
fRange.setDataValidation(rule)

`requireValueInRange`

Sets a data validation rule that requires the user to enter a value within a specific range. The range is defined by an FRange object, which contains the unit ID, sheet name, and cell range.

Signature

requireValueInRange(range: FRange, multiple?: boolean, showDropdown?: boolean): FDataValidationBuilder

Parameters

range (FRange) — - An FRange object representing the range of values that the user can enter.
multiple (boolean) — - Optional parameter indicating whether the user can select multiple values.
showDropdown (boolean) — - Optional parameter indicating whether to display the list in a dropdown.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set the values in the range B1:B2
const fRange = fWorksheet.getRange('B1:B2')
fRange.setValues([
  ['Yes'],
  ['No'],
])

// Create a new data validation rule that requires the user to enter a value from the range B1:B2 for the range A1:A10
const rule = univerAPI.newDataValidation()
  .requireValueInRange(fRange)
  .setOptions({
    allowBlank: false,
    showErrorMessage: true,
    error: 'Please enter a value from the list',
  })
  .build()
const cell = fWorksheet.getRange('A1')
cell.setDataValidation(rule)

`setAllowBlank`

Sets whether to allow blank values.

Signature

setAllowBlank(allowBlank: boolean): FDataValidationBuilder

Parameters

allowBlank (boolean) — - Whether to allow blank values.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

// Assume current sheet is empty data
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set the data validation for cell A1:B2 to allow blank values
const fRange = fWorksheet.getRange('A1:B2')
const rule = univerAPI.newDataValidation()
  .requireValueInList(['Yes', 'No'])
  .setAllowBlank(true)
  .build()
fRange.setDataValidation(rule)

// Set the data validation for cell C1:D2 to not allow blank values
const fRange2 = fWorksheet.getRange('C1:D2')
const rule2 = univerAPI.newDataValidation()
  .requireValueInList(['Yes', 'No'])
  .setAllowBlank(false)
  .build()
fRange2.setDataValidation(rule2)

`setAllowInvalid`

Sets whether to allow invalid data and configures the error style. If invalid data is not allowed, the error style will be set to STOP, indicating that data entry must stop upon encountering an error. If invalid data is allowed, the error style will be set to WARNING, indicating that a warning will be displayed when invalid data is entered, but data entry can continue.

Signature

setAllowInvalid(allowInvalidData: boolean): FDataValidationBuilder

Parameters

allowInvalidData (boolean) — - Whether to allow invalid data.

Returns

(FDataValidationBuilder) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Set the data validation for cell A1:B2 to allow invalid data, so A1:B2 will display a warning when invalid data is entered
const fRange = fWorksheet.getRange('A1:B2')
const rule = univerAPI.newDataValidation()
  .requireValueInList(['Yes', 'No'])
  .setAllowInvalid(true)
  .build()
fRange.setDataValidation(rule)

// Set the data validation for cell C1:D2 to not allow invalid data, so C1:D2 will stop data entry when invalid data is entered
const fRange2 = fWorksheet.getRange('C1:D2')
const rule2 = univerAPI.newDataValidation()
  .requireValueInList(['Yes', 'No'])
  .setAllowInvalid(false)
  .build()
fRange2.setDataValidation(rule2)

`setOptions`

Sets the options for the data validation rule.

Signature

setOptions(options: Partial<IDataValidationRuleOptions>): this

Parameters

options (Partial<IDataValidationRuleOptions>) — - The options to set for the data validation rule.

Returns

(this) — The current instance for method chaining.

Examples

const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()

// Create a new data validation rule that requires the user to enter a value from the list ['Yes', 'No'] for the range A1:B10
const fRange = fWorksheet.getRange('A1:B10')
const rule = univerAPI.newDataValidation()
  .requireValueInList(['Yes', 'No'])
  .setOptions({
    allowBlank: true,
    showErrorMessage: true,
    error: 'Please enter a value from the list',
  })
  .build()
fRange.setDataValidation(rule)

FDataValidationBuilder

APIs

`build`

`copy`

`getAllowInvalid`

`getCriteriaType`

`getCriteriaValues`

`getHelpText`

`requireCheckbox`

`requireDateAfter`

`requireDateBefore`

`requireDateBetween`

`requireDateEqualTo`

`requireDateNotBetween`

`requireDateOnOrAfter`

`requireDateOnOrBefore`

`requireFormulaSatisfied`

`requireNumberBetween`

`requireNumberEqualTo`

`requireNumberGreaterThan`

`requireNumberGreaterThanOrEqualTo`

`requireNumberLessThan`

`requireNumberLessThanOrEqualTo`

`requireNumberNotBetween`

`requireNumberNotEqualTo`

`requireValueInList`

`requireValueInRange`

`setAllowBlank`

`setAllowInvalid`

`setOptions`

Table of Contents