Excel.Interfaces.DataValidationLoadOptions interface

  • Reference
Package:
excel

Warning

This API is now deprecated.

Represents the data validation applied to the current range. To learn more about the data validation object model, read Add data validation to Excel ranges.

Remarks

[ API set: ExcelApi 1.8 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
errorAlert

Error alert when user enters invalid data.
ignoreBlanks

Specifies if data validation will be performed on blank cells. Default is true.
prompt

Prompt when users select a cell.
rule

Data validation rule that contains different type of data validation criteria.
type

Type of the data validation, see Excel.DataValidationType for details.
valid

Represents if all cell values are valid according to the data validation rules. Returns true if all cell values are valid, or false if all cell values are invalid. Returns null if there are both valid and invalid cell values within the range.

Property Details

$all

Warning

This API is now deprecated.

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

errorAlert

Warning

This API is now deprecated.

Error alert when user enters invalid data.

errorAlert?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

ignoreBlanks

Warning

This API is now deprecated.

Specifies if data validation will be performed on blank cells. Default is true.

ignoreBlanks?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

prompt

Warning

This API is now deprecated.

Prompt when users select a cell.

prompt?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

rule

Warning

This API is now deprecated.

Data validation rule that contains different type of data validation criteria.

rule?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

type

Warning

This API is now deprecated.

Type of the data validation, see Excel.DataValidationType for details.

type?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

valid

Warning

This API is now deprecated.

Represents if all cell values are valid according to the data validation rules. Returns true if all cell values are valid, or false if all cell values are invalid. Returns null if there are both valid and invalid cell values within the range.

valid?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]