ig.excel.CriterionBase
Dependencies
-
formula
- .formula( );
Returns the formula which determines whether cell values meet the criteria defined by the associated condition.
Remarks
This property is only applicable when the CriterionBase.valueType property is set to Formula.
To assign a formula, use the CriterionBase.setFormula method.
See Also
-
setFormula
- .setFormula( formula:string, [cellReferenceMode:ig.excel.CellReferenceMode], [valueType:ig.excel.FormatConditionValueType] );
Assigns the specified formula to the CriterionBase.formula property, and assigns a value of Formula to the CriterionBase.valueType property.
- formula
- Type:string
- The string representation of the CriterionBase.formula to be assigned to the CriterionBase.value property.
- cellReferenceMode
- Type:ig.excel.CellReferenceMode
- Optional
- A CellReferenceMode value which specifies whether the formula parameter should be interpreted as an A1 or R1C1 expression. This parameter is optional and defaults to null, in which case the Workbook.cellReferenceMode property is used.
- valueType
- Type:ig.excel.FormatConditionValueType
- Optional
- A FormatConditionValueType value which specifies the manner in which the value returned from the formula is interpreted. This parameter is optional and defaults to 'Formula'.
-
setValue
- .setValue( valueType:ig.excel.FormatConditionValueType );
Sets the CriterionBase.valueType property to the specified FormatConditionValueType value.
- valueType
- Type:ig.excel.FormatConditionValueType
- The new value for the CriterionBase.valueType property.
Remarks
The valueType parameter must be set to one of the following values or an exception is thrown:
- AutomaticLowest
- AutomaticHighest
- LowestValue
- HighestValue
To set the CriterionBase.value property to a numeric value, use the CriterionBase.setValue method.
To set the CriterionBase.valueType property to Formula, use the CriterionBase.setFormula method.
-
setValue
- .setValue( value:number, valueType:ig.excel.FormatConditionValueType );
Sets the CriterionBase.value and CriterionBase.valueType properties to the specified values.
- value
- Type:number
- The new value for the CriterionBase.value property.
- valueType
- Type:ig.excel.FormatConditionValueType
- The new value for the CriterionBase.valueType property. Must be set to either Number, Percentage, or Percentile or an exception is thrown.
Remarks
To set the CriterionBase.valueType property to Formula, use the CriterionBase.setFormula method.
To set the CriterionBase.valueType property to a FormatConditionValueType value for which the CriterionBase.value is not applicable, use the CriterionBase.setValue method.
-
value
- .value( );
Returns the numeric value for this instance.
Remarks
This property is read-only; to assign a value type, use the CriterionBase.setValue or CriterionBase.setValue methods.
Note that the unit of measure for this value is determined by the CriterionBase.valueType property; for example, when ValueType is set to Number, the value is interpreted as a numeric value, but when set to Percentage, it is interpreted as a percentage.
-
valueType
- .valueType( );
Returns a FormatConditionValueType value which specifies the manner in which the threshold values for this instance are determined.
Remarks
This property is read-only; to assign one of the following value types, use the CriterionBase.setValue method:
- AutomaticLowest
- AutomaticHighest
- LowestValue
- HighestValue
To assign a value type of Number, Percentage, or Percentileuse the CriterionBase.setValue method.
To assign a CriterionBase.formula, use the CriterionBase.setFormula method.
See Also