tblIRule SetValue

Sets the reference value that is to be compared with the actual value in the cell to determine if the cell passes the rule.

Syntax

tblIRule_handle SetValue ValueToCompareWith

Application

Tcl Query

Description

To set up conditional formatting of table cells, you must first add a rule. Next, you must the rule handle and set the relevant parameters on the rule handle. These parameters are used to decide the formatting of the cells that are part of the rule.

One such parameter is the reference value that is to be compared with the actual value in the cell to determine if the cell passes the rule. This API helps in setting the same.

Inputs

ValueToCompareWith: The reference value that is to be compared with the actual value in the cell to determine if the cell passes the rule.

Example

set t [hw::GetT]
set activetableHandle [hwi GetActiveClientHandle ch$t]
set ruleid [ch$t AddRule]
set ruleHandle [$activetableHandle GetRuleHandle rh$ruleid $ruleid]
$ruleHandle SetCellList "A1 A2 B1 B2"
$ruleHandle SetBackgroundColor 3
$ruleHandle SetTextColor 0
$ruleHandle SetValue 10
puts "Rule Id: $ruleid will use [$ruleHandle GetValue] as the reference value."
$ruleHandle SetOperator ">"
$ruleHandle ReleaseHandle

Errors

Returns success(0) or an error code.