Represents a data validation rule which allows a value from a list of accepted values to be applied to a cell.

See

Hierarchy

Hierarchy

Constructors

Properties

$type: Type
$t: Type
nextHashCode: number

Accessors

  • get allowNull(): boolean
  • Gets or sets the value which indicates whether a null, or blank, value is allowed to be set on a cell. True if a null value can be set on the cell; False otherwise.

    Returns boolean

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

    • a: boolean

    Returns void

  • 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 showDropdown(): boolean
  • Gets or sets the value which indicates whether a drop down should be displayed in Microsoft Excel with the list of accepted values.

    If this is True, a drop down arrow will be displayed next to the cell when it is selected. When the user clicks the drop down arrow, a drop down will be displayed with the list of accepted values.

    Returns boolean

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

    • a: boolean

    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

  • Gets the formula which specifies the accepted values.

    The is a string containing the list of accepted values or a reference to a cell or region in the same Workbook which contains the accepted values.

    If the formula equals a string, it will be a list of accepted value, such as ="A,B,C". If one of the values must contain a double quote ("), the character will be repeated in the list, like so: ="A,""B"",C". This will allow the values A, "B", and C. The separator between values will be a comma (,), unless the decimal separator for the current culture is a comma, in which case the separator will be a semicolon (;).

    If the formula equals one or more references, it will be a reference to a single cell or region in the same Workbook. Union, intersection, and range operators are not allowed. An formula might be something like =$A$1 or =Sheet2!$A$1:$A$5. In addition to a single cell or region, a named reference can also be used, but only if it refers to a single cell or region. If a region is specified, or a named reference that refers to a region, the region will consist of a single row or column. A formula that equals an error value can also be returned, but will cause the cell to not accept any values and the drop down to be empty, so it is not very useful.

    The address passed in is only needed if relative addresses are used in the the formula. For example, consider the formula applied is =B1, and the data validation rule is applied to the region A1:A5. If you get the formula for A1, the formula =B1 will be returned. If you get the formula for A2, =B2 will be returned. Similarly, for cell A5, =B5 will be returned. However, if the formula contains no references or all absolute references, the 'address' is ignored. So in the previous example, if the original formula was =$B$1, the same formula will be returned regardless of the specified address.

    'address' can be any valid cell or region reference on a worksheet. If a region address is specified, the top-left cell or the region is used. The cell or region specified does not need to have the data validation rule applied to it. Any reference is allowed.

    The cell reference mode with which to parse 'address' will be assumed to be A1, unless the data validation rule is applied to a worksheet which is in a workbook, in which case the Workbook.cellReferenceMode will be used.

    Throws

    ArgumentException Occurs when 'address' is not a valid cell or regions address.

    Returns

    A formula used to validate the value applied to a cell.

    See

    Parameters

    • address: string

      The address of the cell or region that serves as the basis for relative references, or null to use the top-left cell of the worksheet.

    Returns string

  • Gets the formula which specifies the accepted values.

    The is a string containing the list of accepted values or a reference to a cell or region in the same Workbook which contains the accepted values.

    If the formula equals a string, it will be a list of accepted value, such as ="A,B,C". If one of the values must contain a double quote ("), the character will be repeated in the list, like so: ="A,""B"",C". This will allow the values A, "B", and C. The separator between values will be a comma (,), unless the decimal separator for the current culture is a comma, in which case the separator will be a semicolon (;).

    If the formula equals one or more references, it will be a reference to a single cell or region in the same Workbook. Union, intersection, and range operators are not allowed. An formula might be something like =$A$1 or =Sheet2!$A$1:$A$5. In addition to a single cell or region, a named reference can also be used, but only if it refers to a single cell or region. If a region is specified, or a named reference that refers to a region, the region will consist of a single row or column. A formula that equals an error value can also be returned, but will cause the cell to not accept any values and the drop down to be empty, so it is not very useful.

    The address passed in is only needed if relative addresses are used in the the formula. For example, consider the formula applied is =B1, and the data validation rule is applied to the region A1:A5. If you get the formula for A1, the formula =B1 will be returned. If you get the formula for A2, =B2 will be returned. Similarly, for cell A5, =B5 will be returned. However, if the formula contains no references or all absolute references, the 'address' is ignored. So in the previous example, if the original formula was =$B$1, the same formula will be returned regardless of the specified address.

    'address' can be any valid cell or region reference on a worksheet. If a region address is specified, the top-left cell or the region is used. The cell or region specified does not need to have the data validation rule applied to it. Any reference is allowed.

    Throws

    ArgumentException Occurs when 'address' is not a valid cell or regions address.

    Throws

    InvalidEnumArgumentException Occurs when 'format' is not defined in the WorkbookFormat enumeration.

    Throws

    InvalidEnumArgumentException Occurs when 'cellReferenceMode' is not defined in the CellReferenceMode enumeration.

    Returns

    A formula used to validate the value applied to a cell.

    See

    Parameters

    • address: string

      The address of the cell or region that serves as the basis for relative references, or null to use the top-left cell of the worksheet.

    • format: WorkbookFormat

      The workbook format with which to parse 'address'.

    • cellReferenceMode: CellReferenceMode

      The cell reference mode with which to parse 'address'.

    • culture: string | CultureInfo

      The culture to use when generating the formula string.

    Returns string

  • 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

  • Sets the list of accepted values the cell can accept.

    If LimitedValueDataValidationRule.allowNull is True, null values are allowed in addition to the list of accepted values.

    All values will have ToString called on them to covert the accepted values list to a formula.

    Note: the formula of accepted values is created by separating each value with a function parameter separator and concatenating them into a single string. So a list of 1, 2, and 3 would have the following formula created: ="1,2,3". However, if the decimal separator of the current culture is a comma (,) then a semicolon (;) will be used to separate the values instead. Because of this, if the ToString of a value returns a string which contains one of these separators, the value will be split into two or more allowed values.

    Throws

    ArgumentNullException Occurs when 'values' is null and the rule is currently applied to a Worksheet.

    Throws

    ArgumentException Occurs when the 'values' array is empty.

    See

    Parameters

    • Rest ...values: any[]

      The list of accepted values.

    Returns void

  • Sets the formula which specifies the accepted values.

    The formula must be a string containing the list of accepted values or a reference to a cell or region in the same Workbook which contains the accepted values.

    If a formula equaling a string is specified, it must be a string literal and it cannot be concatenated. For example, an acceptable formula would be ="A,B,C". If one of the values must contain a double quote ("), the character should be repeated in the list, like so: ="A,""B"",C". This will allow the values A, "B", and C. The separator between values must be a comma (,), unless the decimal separator for the current culture is a comma, in which case the separator must be a semicolon (;).

    If a formula equaling one or more references is specified, it must be a reference to a single cell or region in the same Workbook. Union, intersection, and range operators are not allowed. An acceptable formula might be =$A$1 or =Sheet2!$A$1:$A$5. In addition to a single cell or region, a named reference can also be used, but only if it refers to a single cell or region. If a region is specified, or a named reference that refers to a region, the region must consist of a single row or column. A formula that equals an error value is also allowed, but will cause the cell to not accept any values and the drop down to be empty, so it is not very useful.

    The address passed in is only needed if relative addresses are used in the the formula. When the data validation rule is applied to cells or regions, the references in the formula used by each individual cell will be shifted by the offset of the cell to the passed in 'address'. For example, consider the formula specified is =B1 and the specified address is A1. If the data validation rule is then applied to the A5 cell, the formula is will use is =B5. However, if the references in the formula are absolute, such as =$B$1, the same formula will be applied regardless of the specified address.

    'address' can be any valid cell or region reference on a worksheet. If a region address is specified, the top-left cell or the region is used. The cell or region specified does not need to have the data validation rule applied to it. Any reference is allowed.

    The cell reference mode with which to parse 'address' will be assumed to be A1, unless the data validation rule is applied to a worksheet which is in a workbook, in which case the Workbook.cellReferenceMode will be used.

    Throws

    ArgumentNullException Occurs when 'valuesFormula' is null and the rule is currently applied to a Worksheet.

    Throws

    FormulaParseException Occurs when 'valuesFormula' is not a valid formula.

    Throws

    ArgumentException Occurs when the specified value contains something other than a string or reference.

    Throws

    ArgumentException Occurs when the specified value contains a region reference which has more than one row and column.

    Throws

    ArgumentException Occurs when 'address' is not a valid cell or regions address.

    See

    Parameters

    • valuesFormula: string

      The formula which provides the accepted values for the rule.

    • address: string

      The address of the cell or region that serves as the basis for relative references, or null to use the top-left cell of the worksheet.

    Returns void

  • Sets the formula which specifies the accepted values.

    The formula must be a string containing the list of accepted values or a reference to a cell or region in the same Workbook which contains the accepted values.

    If a formula equaling a string is specified, it must be a string literal and it cannot be concatenated. For example, an acceptable formula would be ="A,B,C". If one of the values must contain a double quote ("), the character should be repeated in the list, like so: ="A,""B"",C". This will allow the values A, "B", and C. The separator between values must be a comma (,), unless the decimal separator for the current culture is a comma, in which case the separator must be a semicolon (;).

    If a formula equaling one or more references is specified, it must be a reference to a single cell or region in the same Workbook. Union, intersection, and range operators are not allowed. An acceptable formula might be =$A$1 or =Sheet2!$A$1:$A$5. In addition to a single cell or region, a named reference can also be used, but only if it refers to a single cell or region. If a region is specified, or a named reference that refers to a region, the region must consist of a single row or column. A formula that equals an error value is also allowed, but will cause the cell to not accept any values and the drop down to be empty, so it is not very useful.

    The address passed in is only needed if relative addresses are used in the the formula. When the data validation rule is applied to cells or regions, the references in the formula used by each individual cell will be shifted by the offset of the cell to the passed in 'address'. For example, consider the formula specified is =B1 and the specified address is A1. If the data validation rule is then applied to the A5 cell, the formula is will use is =B5. However, if the references in the formula are absolute, such as =$B$1, the same formula will be applied regardless of the specified address.

    'address' can be any valid cell or region reference on a worksheet. If a region address is specified, the top-left cell or the region is used. The cell or region specified does not need to have the data validation rule applied to it. Any reference is allowed.

    Throws

    ArgumentNullException Occurs when 'valuesFormula' is null and the rule is currently applied to a Worksheet.

    Throws

    FormulaParseException Occurs when 'valuesFormula' is not a valid formula.

    Throws

    ArgumentException Occurs when the specified value contains something other than a string or reference.

    Throws

    ArgumentException Occurs when the specified value contains a region reference which has more than one row and column.

    Throws

    ArgumentException Occurs when 'address' is not a valid cell or regions address.

    Throws

    InvalidEnumArgumentException Occurs when 'format' is not defined in the WorkbookFormat enumeration.

    Throws

    InvalidEnumArgumentException Occurs when 'cellReferenceMode' is not defined in the CellReferenceMode enumeration.

    See

    Parameters

    • valuesFormula: string

      The formula which provides the accepted values for the rule.

    • address: string

      The address of the cell or region that serves as the basis for relative references, or null to use the top-left cell of the worksheet.

    • format: WorkbookFormat

      The workbook format with which to parse 'address'.

    • cellReferenceMode: CellReferenceMode

      The cell reference mode with which to parse 'address'.

    • culture: string | CultureInfo

      The culture to use when parsing the formula string.

    Returns void

  • Parameters

    • item1: any
    • item2: any

    Returns number