ig.excel.OperatorConditionalFormat
Dependencies
-
operand1
- .operand1( );
- Return Type:
- ig.excel.Formula
- Return Type Description:
- Returns a Formula.
Returns the formula which defines the criteria for the first operand of this condition.
Remarks
This property is not directly settable; however, the following methods can be used to assign a formula:
- OperatorConditionalFormat.setOperand1
- OperatorConditionalFormat.setOperand1
- OperatorConditionalFormat.setOperand1
- OperatorConditionalFormat.setOperand1Formula
When the OperatorConditionalFormat.operator property is set to Between or NotBetween, this property defines the lower limit of the range for "between" comparisons.
Use the OperatorConditionalFormat.operand2 property to define the upper limit of the range for "between" comparisons.
-
operand2
- .operand2( );
- Return Type:
- ig.excel.Formula
- Return Type Description:
- Returns a Formula.
Returns a formula for the second operand which defines the criteria for this condition when the OperatorConditionalFormat.operator property is set to Between or NotBetween
Remarks
This property is only applicable when the OperatorConditionalFormat.operator property is set to Between or NotBetween.
Use this property to define the upper limit of the range for "between" comparisons, and the OperatorConditionalFormat.operand1 property to define the lower limit.
This property is not directly settable; however, the following methods can be used to assign a formula:
-
operator
- .operator( );
- Return Type:
- ig.excel.FormatConditionOperator
- Return Type Description:
- Returns a FormatConditionOperator.
Returns a FormatConditionOperator constant which determines the manner in which the cell value is compared against the OperatorConditionalFormat.operand1 property.
Remarks
This property determines how the cell value is compared to the OperatorConditionalFormat.operand1 property; for example, whether it is equal, greater than, less than, etc.
For the FormatConditionOperator values 'Between' and 'NotBetween', the OperatorConditionalFormat.operand2 property must also be set.
-
operator
- .operator( value:ig.excel.FormatConditionOperator );
- Return Type:
- ig.excel.FormatConditionOperator
- Return Type Description:
- Returns a FormatConditionOperator.
Returns a FormatConditionOperator constant which determines the manner in which the cell value is compared against the OperatorConditionalFormat.operand1 property.
- value
- Type:ig.excel.FormatConditionOperator
Remarks
This property determines how the cell value is compared to the OperatorConditionalFormat.operand1 property; for example, whether it is equal, greater than, less than, etc.
For the FormatConditionOperator values 'Between' and 'NotBetween', the OperatorConditionalFormat.operand2 property must also be set.
-
setOperand1
- .setOperand1( value:ig.Date );
Assigns the specified System.DateTime value to the OperatorConditionalFormat.operand1 property.
- value
- Type:ig.Date
- The System.DateTime value to assign.
-
setOperand1
- .setOperand1( value:number );
Assigns the specified System.Double value to the OperatorConditionalFormat.operand1 property.
- value
- Type:number
- The System.Double value to assign.
-
setOperand1
- .setOperand1( value:string );
Assigns the specified System.String value to the OperatorConditionalFormat.operand1 property.
- value
- Type:string
- The System.String value to assign.
-
setOperand1Formula
- .setOperand1Formula( formula:string, [cellReferenceMode:ig.excel.CellReferenceMode] );
Assigns a Formula to the OperatorConditionalFormat.operand1 property.
- formula
- Type:string
- The string representation of the Formula to be assigned to the OperatorConditionalFormat.operand1 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.
Remarks
Note that the value of the formula parameter must begin with an equals sign (=).
-
setOperand2
- .setOperand2( value:ig.Date );
Assigns the specified System.DateTime value to the OperatorConditionalFormat.operand2 property.
- value
- Type:ig.Date
- The System.DateTime value to assign.
-
setOperand2
- .setOperand2( value:number );
Assigns the specified System.Double value to the OperatorConditionalFormat.operand2 property.
- value
- Type:number
- The System.Double value to assign.
-
setOperand2
- .setOperand2( value:string );
Assigns the specified System.String value to the OperatorConditionalFormat.operand2 property.
- value
- Type:string
- The System.String value to assign.
-
setOperand2Formula
- .setOperand2Formula( formula:string, [cellReferenceMode:ig.excel.CellReferenceMode] );
Assigns a Formula to the OperatorConditionalFormat.operand2 property.
- formula
- Type:string
- The string representation of the Formula to be assigned to the OperatorConditionalFormat.operand2 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.
Remarks
Note that the value of the formula parameter must begin with an equals sign (=).