Base class for all data validations rules which can be applied to a cell.

Constructors

Section titled "Constructors"

DataValidationRule 

new DataValidationRule(): DataValidationRule

Returns DataValidationRule

Properties

Section titled "Properties"

$t

Section titled "$t" 
$t: Type

Accessors

Section titled "Accessors"

errorMessageDescription

Section titled "errorMessageDescription"

Gets or sets the description which appears in the dialog box when an invalid value is applied to a cell in Microsoft Excel.

 
get errorMessageDescription(): string

Returns string 

set errorMessageDescription(a: string): void

Parameters

  • a: string

Returns void

errorMessageTitle

Section titled "errorMessageTitle"

Gets or sets the title which appears in the dialog box when an invalid value is applied to a cell in Microsoft Excel.

 
get errorMessageTitle(): string

Returns string 

set errorMessageTitle(a: string): void

Parameters

  • a: string

Returns void

errorStyle

Section titled "errorStyle"

Gets or sets the value which indicates whether the value is allowed when it is invalid and which options are given to the user in the error dialog shown by Microsoft Excel.

 
get errorStyle(): DataValidationErrorStyle

Returns DataValidationErrorStyle 

set errorStyle(a: DataValidationErrorStyle): void

Parameters

Returns void

imeMode

Section titled "imeMode"

Gets or sets the description of the Japanese input rules.

 
get imeMode(): DataValidationImeMode

Returns DataValidationImeMode 

set imeMode(a: DataValidationImeMode): void

Parameters

Returns void

inputMessageDescription

Section titled "inputMessageDescription"

Gets or sets the description in the tooltip which appears when the user selects the cell in Microsoft Excel.

 
get inputMessageDescription(): string

Returns string 

set inputMessageDescription(a: string): void

Parameters

  • a: string

Returns void

inputMessageTitle

Section titled "inputMessageTitle"

Gets or sets the title in the tooltip which appears when the user selects the cell in Microsoft Excel.

 
get inputMessageTitle(): string

Returns string 

set inputMessageTitle(a: string): void

Parameters

  • a: string

Returns void

showErrorMessageForInvalidValue

Section titled "showErrorMessageForInvalidValue"

Gets or sets the value which indicates whether the error dialog should appear in Microsoft Excel when invalid data is entered in the cell.

 
get showErrorMessageForInvalidValue(): boolean

Returns boolean 

set showErrorMessageForInvalidValue(a: boolean): void

Parameters

  • a: boolean

Returns void

showInputMessage

Section titled "showInputMessage"

Gets or sets the value which indicates whether to show the user an input prompt tooltip when the user selects the cell in Microsoft Excel.

 
get showInputMessage(): boolean

Returns boolean 

set showInputMessage(a: boolean): void

Parameters

  • a: boolean

Returns void

Methods

Section titled "Methods"

clone

Section titled "clone"

Creates a copy of this rule which can be applied to other worksheets.

 
clone(): DataValidationRule

Returns DataValidationRule

isEquivalentTo

Section titled "isEquivalentTo"

Indicates if this rule is structurally equivalent to another.

 
isEquivalentTo(other: DataValidationRule): boolean

Parameters

Returns boolean