Represents a data validation rule which allows any value to be set on the target cells. This would be used to provide an input message to the user when the cell was selected.

See

  • [[Worksheet.dataValidationRules]]
  • [[DataValidationRuleCollection.add]]
  • [[DataValidationRuleCollection.add]]

Hierarchy

Hierarchy (view full)

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get errorMessageDescription(): string
  • Gets or sets the description which appears in the dialog box when an invalid value is applied to a cell in Microsoft Excel.

    This value is only used when [[showErrorMessageForInvalidValue]] is True.

    Note: the title cannot be more than 225 characters.

    The description to show the user or null to use a default error description.

    Throws

    [[ArgumentException]] Occurs when the specified value is longer than 225 characters.

    See

    [[errorMessageTitle]]

    Returns string

  • set errorMessageDescription(a): void
  • Parameters

    • a: string

    Returns void

  • get errorMessageTitle(): string
  • Gets or sets the title which appears in the dialog box when an invalid value is applied to a cell in Microsoft Excel.

    This value is only used when [[showErrorMessageForInvalidValue]] is True.

    Note: the title cannot be more than 32 characters.

    The title to show the user or null to use a default error dialog title.

    Throws

    [[ArgumentException]] Occurs when the specified value is longer than 32 characters.

    See

    [[errorMessageDescription]]

    Returns string

  • set errorMessageTitle(a): void
  • Parameters

    • a: string

    Returns void

  • get errorStyle(): DataValidationErrorStyle
  • 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.

    This value is only used when [[showErrorMessageForInvalidValue]] is True.

    Throws

    [[InvalidEnumArgumentException]] Occurs when the value is not a member of the [[DataValidationErrorStyle]] enumeration.

    See

    [[showErrorMessageForInvalidValue]]

    Returns DataValidationErrorStyle

  • set errorStyle(a): void
  • Parameters

    Returns void

  • get imeMode(): DataValidationImeMode
  • Gets or sets the description of the Japanese input rules.

    Throws

    [[InvalidEnumArgumentException]] Occurs when the value is not a member of the [[DataValidationImeMode]] enumeration.

    Returns DataValidationImeMode

  • set imeMode(a): void
  • Parameters

    Returns void

  • get inputMessageDescription(): string
  • Gets or sets the description in the tooltip which appears when the user selects the cell in Microsoft Excel.

    This value is only used when [[showInputMessage]] is True.

    Note: the description cannot be more than 255 characters.

    The description to show the user in the tooltip.

    Throws

    [[ArgumentException]] Occurs when the specified value is longer than 255 characters.

    See

    [[inputMessageTitle]]

    Returns string

  • set inputMessageDescription(a): void
  • Parameters

    • a: string

    Returns void

  • get inputMessageTitle(): string
  • Gets or sets the title in the tooltip which appears when the user selects the cell in Microsoft Excel.

    This value is only used when [[showInputMessage]] is True.

    Note: the title cannot be more than 32 characters.

    The title to show the user in the tooltip.

    Throws

    [[ArgumentException]] Occurs when the specified value is longer than 32 characters.

    See

    [[inputMessageDescription]]

    Returns string

  • set inputMessageTitle(a): void
  • Parameters

    • a: string

    Returns void

  • get showErrorMessageForInvalidValue(): boolean
  • Gets or sets the value which indicates whether the error dialog should appear in Microsoft Excel when invalid data is entered in the cell.

    When the value is False, invalid data can be entered into cells, but when the user chooses to subsequently circle invalid values in Microsoft Excel, the cell will be circled.

    True to show the error dialog for invalid cell data; False otherwise.

    See

    • [[errorMessageDescription]]
    • [[errorMessageTitle]]
    • [[errorStyle]]

    Returns boolean

  • set showErrorMessageForInvalidValue(a): void
  • Parameters

    • a: boolean

    Returns void

  • get showInputMessage(): boolean
  • 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.

    The input prompt will only be shown if this value is True and the [[inputMessageDescription]] is not null.

    See

    • [[inputMessageDescription]]
    • [[inputMessageTitle]]

    Returns boolean

  • set showInputMessage(a): void
  • Parameters

    • a: boolean

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

  • Returns number

  • Indicates if this rule is structurally equivalent to another.

    Parameters

    Returns boolean

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns number

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

  • Parameters

    • obj: any

    Returns any[]

  • Parameters

    • obj: any

    Returns number

  • Parameters

    • a: any
    • b: any

    Returns boolean