tblIRule SetCellList

Sets the list of cell names on which this rule should act.

Syntax

tblIRule_handle SetCellList cellList

Application

Tcl Query

Description

To set up conditional formatting of table cells, you must first add a rule. Then, you must get 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 list of cell names on which this rule should act. This API helps in setting the same.

Inputs

cellList: The list of cell names. For example, A1 A2.

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"
puts "Rule Id: $ruleid acts on cells [$ruleHandle GetCellList]"
$ruleHandle SetBackgroundColor 3
$ruleHandle SetTextColor 0
$ruleHandle SetValue 10
$ruleHandle SetOperator ">"
$ruleHandle ReleaseHandle

Errors

Returns success(0) or an error code.