ig.excel.OneConstraintDataValidationRule
Dependencies
-
ig.excel.OneConstraintDataValidationRule
Constructor- new $.ig.excel.OneConstraintDataValidationRule( );
Creates a new OneConstraintDataValidationRule instance.
-
ig.excel.OneConstraintDataValidationRule
Constructor- new $.ig.excel.OneConstraintDataValidationRule( validationOperator:ig.excel.OneConstraintDataValidationOperator, validationCriteria:ig.excel.DataValidationCriteria );
Creates a new OneConstraintDataValidationRule instance.
- validationOperator
- Type:ig.excel.OneConstraintDataValidationOperator
- The operator to use when comparing the cell value to the constraint value.
- validationCriteria
- Type:ig.excel.DataValidationCriteria
- The criteria to use when validating the cell value.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException Occurs when the validationCriteria is not a member of the DataValidationCriteria enumeration. -
getConstraintFormula
- .getConstraintFormula( address:string );
- Return Type:
- string
- Return Type Description:
- A formula used to validate the value applied to a cell.
Gets the constraint formula used to validate the cell value.
- address
- Type: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.
Exceptions
Exception Description ig.ArgumentException Occurs when address is not a valid cell or regions address. Remarks
The way in which the cell value is compared to the constraint formula's value is determined by the OneConstraintDataValidationRule.validationOperator as well as the ValueConstraintDataValidationRule.validationCriteria.
Depending on the ValidationCriteria of the rule, either the cell value itself or the length of the cell value's text equivalent is compared to the constraint formula's value.
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.
See Also
-
getConstraintFormula
- .getConstraintFormula( address:string, format:ig.excel.WorkbookFormat, cellReferenceMode:ig.excel.CellReferenceMode, culture:string );
- Return Type:
- string
- Return Type Description:
- A formula used to validate the value applied to a cell.
Gets the constraint formula used to validate the cell value.
- address
- Type: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
- Type:ig.excel.WorkbookFormat
- The workbook format with which to parse address.
- cellReferenceMode
- Type:ig.excel.CellReferenceMode
- The cell reference mode with which to parse address.
- culture
- Type:string
- The culture to use when generating the formula string.
Exceptions
Exception Description ig.ArgumentException Occurs when address is not a valid cell or regions address. ig.excel.InvalidEnumArgumentException Occurs when format is not defined in the WorkbookFormat enumeration. ig.excel.InvalidEnumArgumentException Occurs when cellReferenceMode is not defined in the CellReferenceMode enumeration. Remarks
The way in which the cell value is compared to the constraint formula's value is determined by the OneConstraintDataValidationRule.validationOperator as well as the ValueConstraintDataValidationRule.validationCriteria.
Depending on the ValidationCriteria of the rule, either the cell value itself or the length of the cell value's text equivalent is compared to the constraint formula's value.
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.
See Also
-
setConstraint
- .setConstraint( value:ig.Date );
Sets the constraint value used to validate the cell value.
- value
- Type:ig.Date
- The constraint value used to compare against the cell value.
Exceptions
Exception Description ig.ArgumentException Occurs when value cannot be represented as a date in Excel. Remarks
The way in which the cell value is compared to the constraint value is determined by the OneConstraintDataValidationRule.validationOperator as well as the ValueConstraintDataValidationRule.validationCriteria.
Depending on the ValidationCriteria of the rule, either the cell value itself or the length of the cell value's text equivalent is compared to the constraint value.
This overload is preferred when the ValidationCriteria is Date. When the ValidationCriteria is WholeNumber, Decimal, Time, or TextLength, the OneConstraintDataValidationRule.setConstraint overload is preferred.
See Also
-
setConstraint
- .setConstraint( value:number );
Sets the constraint value used to validate the cell value.
- value
- Type:number
- The constraint value used to compare against the cell value.
Remarks
The way in which the cell value is compared to the constraint value is determined by the OneConstraintDataValidationRule.validationOperator as well as the ValueConstraintDataValidationRule.validationCriteria.
Depending on the ValidationCriteria of the rule, either the cell value itself or the length of the cell value's text equivalent is compared to the constraint value.
This overload is preferred when the ValidationCriteria is WholeNumber, Decimal, Time, or TextLength. When the ValidationCriteria is Date, the OneConstraintDataValidationRule.setConstraint overload is preferred.
See Also
-
setConstraintFormula
- .setConstraintFormula( constraintFormula:string, address:string );
Sets the constraint formula used to validate the cell value.
- constraintFormula
- Type:string
- The validation formula to use for the rule.
- address
- Type: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.
Exceptions
Exception Description ig.ArgumentNullException Occurs when constraintFormula is null and the rule is currently applied to a Worksheet. ig.excel.FormulaParseException Occurs when constraintFormula is not a valid formula. ig.ArgumentException Occurs when address is not a valid cell or regions address. Remarks
The way in which the cell value is compared to the constraint formula's value is determined by the OneConstraintDataValidationRule.validationOperator as well as the ValueConstraintDataValidationRule.validationCriteria.
Depending on the ValidationCriteria of the rule, either the cell value itself or the length of the cell value's text equivalent is compared to the constraint formula's value.
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.
See Also
-
setConstraintFormula
- .setConstraintFormula( constraintFormula:string, address:string, format:ig.excel.WorkbookFormat, cellReferenceMode:ig.excel.CellReferenceMode, culture:string );
Sets the constraint formula used to validate the cell value.
- constraintFormula
- Type:string
- The validation formula to use for the rule.
- address
- Type: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
- Type:ig.excel.WorkbookFormat
- The workbook format with which to parse address.
- cellReferenceMode
- Type:ig.excel.CellReferenceMode
- The cell reference mode with which to parse address.
- culture
- Type:string
- The culture to use when parsing the formula string.
Exceptions
Exception Description ig.ArgumentNullException Occurs when constraintFormula is null and the rule is currently applied to a Worksheet. ig.excel.FormulaParseException Occurs when constraintFormula is not a valid formula. ig.ArgumentException Occurs when address is not a valid cell or regions address. ig.excel.InvalidEnumArgumentException Occurs when format is not defined in the WorkbookFormat enumeration. ig.excel.InvalidEnumArgumentException Occurs when cellReferenceMode is not defined in the CellReferenceMode enumeration. Remarks
The way in which the cell value is compared to the constraint formula's value is determined by the OneConstraintDataValidationRule.validationOperator as well as the ValueConstraintDataValidationRule.validationCriteria.
Depending on the ValidationCriteria of the rule, either the cell value itself or the length of the cell value's text equivalent is compared to the constraint formula's value.
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.
See Also
-
validationOperator
- .validationOperator( );
Gets the validation operator to use when comparing the cell value against the constraint value or formula.
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException Occurs when the value is not a member of the OneConstraintDataValidationOperator enumeration. Remarks
Depending on the ValueConstraintDataValidationRule.validationCriteria of the rule, either the cell value itself or the length of the cell value's text equivalent is compared to the constraint value or formula.
See Also
-
validationOperator
- .validationOperator( value:ig.excel.OneConstraintDataValidationOperator );
Sets the validation operator to use when comparing the cell value against the constraint value or formula.
- value
- Type:ig.excel.OneConstraintDataValidationOperator
Exceptions
Exception Description ig.excel.InvalidEnumArgumentException Occurs when the value is not a member of the OneConstraintDataValidationOperator enumeration. Remarks
Depending on the ValueConstraintDataValidationRule.validationCriteria of the rule, either the cell value itself or the length of the cell value's text equivalent is compared to the constraint value or formula.
See Also