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

Hierarchy

Hierarchy

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: string): 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: string): void
  • Parameters

    • a: string

    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: string): 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: string): 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

    Returns boolean

  • set showErrorMessageForInvalidValue(a: boolean): 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

    Returns boolean

  • set showInputMessage(a: boolean): void
  • Parameters

    • a: boolean

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

  • Indicates if this rule is structurally equivalent to another.

    Returns

    Returns true if the specified 'other' has the same settings as this rule.

    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

    • a: any
    • b: any

    Returns boolean