Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class DataValidationRuleCollection

A collection of [[DataValidationRule]] instances in a worksheet.

See

[[Worksheet.dataValidationRules]]

Hierarchy

Hierarchy

  • Base
    • DataValidationRuleCollection

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

count

  • get count(): number

  • Gets the number of data validation rules applied on the [[worksheet]].

    Returns number

Methods

[iterator]

add

  • add(rule, cell): void

  • Applies an [[AnyValueDataValidationRule]] to a [[WorksheetCell]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'cell' is null.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the 'cell' already has a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is a total cell of a table.

    See

    [[add]]

    Parameters

    Returns void

  • add(rule, region): void

  • Applies an [[AnyValueDataValidationRule]] to the cells in a [[WorksheetRegion]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'region' is null.

    Throws

    [[ArgumentException]] Occurs when the 'region' is from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'region' already have a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'region' is a total cell of a table.

    See

    [[add]]

    Parameters

    Returns void

  • add(rule, cell): void

  • Applies an [[CustomDataValidationRule]] to a [[WorksheetCell]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'cell' is null.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the 'cell' already has a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is a total cell of a table.

    See

    [[add]]

    Parameters

    Returns void

  • add(rule, region): void

  • Applies an [[CustomDataValidationRule]] to the cells in a [[WorksheetRegion]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'region' is null.

    Throws

    [[ArgumentException]] Occurs when the 'region' is from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'region' already have a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'region' is a total cell of a table.

    See

    [[add]]

    Parameters

    Returns void

  • add(rule, references): void

  • Applies a data validation rule to the a set of references.

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'references' is null.

    Throws

    [[ArgumentException]] Occurs when the 'references' are from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'references' collection are in the totals row of a table.

    Parameters

    Returns void

  • add(rule, references, overwriteExistingRules): void

  • Applies a data validation rule to the a set of references.

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'references' is null.

    Throws

    [[ArgumentException]] Occurs when the 'references' are from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when 'overwriteExistingRules' is False and the one or more of the cells in the 'references' collection already have a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'references' collection are in the totals row of a table.

    Parameters

    • rule: DataValidationRule

      The data validation rule to apply to the set of references.

    • references: WorksheetReferenceCollection

      The reference to which the data validation rule should be applied.

    • overwriteExistingRules: boolean

      Indicates whether cells in the references collection which already have data validation rules should have the rules overwritten.

    Returns void

  • add(rule, cell): void

  • Applies an [[ListDataValidationRule]] to a [[WorksheetCell]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'cell' is null.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the 'cell' already has a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is a total cell of a table.

    See

    [[add]]

    Parameters

    Returns void

  • add(rule, region): void

  • Applies an [[ListDataValidationRule]] to the cells in a [[WorksheetRegion]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'region' is null.

    Throws

    [[ArgumentException]] Occurs when the 'region' is from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'region' already have a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'region' is a total cell of a table.

    See

    [[add]]

    Parameters

    Returns void

  • add(rule, cell): void

  • Applies an [[OneConstraintDataValidationRule]] to a [[WorksheetCell]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'cell' is null.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the 'cell' already has a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is a total cell of a table.

    See

    [[add]]

    Parameters

    Returns void

  • add(rule, region): void

  • Applies an [[OneConstraintDataValidationRule]] to the cells in a [[WorksheetRegion]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'region' is null.

    Throws

    [[ArgumentException]] Occurs when the 'region' is from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'region' already have a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'region' is a total cell of a table.

    See

    [[add]]

    Parameters

    Returns void

  • add(rule, cell): void

  • Applies an [[TwoConstraintDataValidationRule]] to a [[WorksheetCell]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'cell' is null.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the 'cell' already has a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is a total cell of a table.

    See

    [[add]]

    Parameters

    Returns void

  • add(rule, region): void

  • Applies an [[TwoConstraintDataValidationRule]] to the cells in a [[WorksheetRegion]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Throws

    [[ArgumentNullException]] Occurs when 'region' is null.

    Throws

    [[ArgumentException]] Occurs when the 'region' is from a worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the 'rule' already applied to another worksheet.

    Throws

    [[ArgumentException]] Occurs when the 'rule' is invalid based on its rule type's requirements.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'region' already have a data validation rule applied to it.

    Throws

    [[ArgumentException]] Occurs when the one or more of the cells in the 'region' is a total cell of a table.

    See

    [[add]]

    Parameters

    Returns void

clear

  • clear(): void

  • Removes all data validation rules from the [[worksheet]].

    Returns void

contains

  • contains(rule): boolean

  • Determines whether the specified data validation rule exists on the [[worksheet]].

    Parameters

    Returns boolean

  • contains(cell): boolean

  • Determines whether the specified cell has a data validation rule applied to it.

    Throws

    [[ArgumentNullException]] Occurs when 'cell' is null.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is from a worksheet other than this collection.

    Parameters

    Returns boolean

  • contains(references): boolean

  • Determines whether the specified references collection has a data validation rule applied to any of it's cells.

    Throws

    [[ArgumentNullException]] Occurs when 'references' is null.

    Throws

    [[ArgumentException]] Occurs when the 'references' are from a worksheet other than this collection.

    Parameters

    Returns boolean

  • contains(region): boolean

  • Determines whether the specified region has a data validation rule applied to any of it's cells.

    Throws

    [[ArgumentNullException]] Occurs when 'region' is null.

    Throws

    [[ArgumentException]] Occurs when the 'region' is from a worksheet other than this collection.

    Parameters

    Returns boolean

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

findRule

  • findRule(cell): DataValidationRule

  • Find the data validation rule applied to the specified cell.

    Throws

    [[ArgumentNullException]] Occurs when 'cell' is null.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is from a worksheet other than this collection.

    Parameters

    Returns DataValidationRule

getAllReferences

getHashCode

  • getHashCode(): number

  • Returns number

item

  • item(a, b?): WorksheetReferenceCollection

  • Gets or sets the references which have the data validation rule applied to it.

    Throws

    [[ArgumentNullException]] Occurs when the 'rule' is null.

    Throws

    [[KeyNotFoundException]] Occurs when the property is retrieved and the 'rule' is not applied to the [[worksheet]].

    Throws

    [[ArgumentException]] Occurs when the property is set and the value is from a Worksheet other than this collection.

    Throws

    [[ArgumentException]] Occurs when the property is set and the 'rule' is invalid based on its rule type's requirements.

    Parameters

    Returns WorksheetReferenceCollection

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(cell): boolean

  • Removes the data validation rule form the cell if one is applied.

    If the rule is only applied to the specified cell, it will be removed from the collection.

    Throws

    [[ArgumentNullException]] Occurs when 'cell' is null.

    Throws

    [[ArgumentException]] Occurs when the 'cell' is from a worksheet other than this collection.

    Parameters

    • cell: WorksheetCell

      The cell which should have its data validation rule cleared.

    Returns boolean

  • remove(references): boolean

  • Removes the data validation rule form all cells in the specified collection.

    If any rules in the collection are not applied to any cells after this operation, they will be removed from the collection.

    Throws

    [[ArgumentNullException]] Occurs when 'references' is null.

    Throws

    [[ArgumentException]] Occurs when the 'references' are from a worksheet other than this collection.

    Parameters

    Returns boolean

  • remove(region): boolean

  • Removes the data validation rule form all cells in the specified region.

    If any rules in the collection are not applied to any cells after this operation, they will be removed from the collection.

    Throws

    [[ArgumentNullException]] Occurs when 'region' is null.

    Throws

    [[ArgumentException]] Occurs when the 'region' is from a worksheet other than this collection.

    Parameters

    • region: WorksheetRegion

      The region which should have its data validation rules cleared.

    Returns boolean

removeItem

  • removeItem(rule): boolean

  • Removes the specified rule from the [[worksheet]].

    Throws

    [[ArgumentNullException]] Occurs when 'rule' is null.

    Parameters

    Returns boolean

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static staticInit

  • staticInit(): void

  • Returns void