tblITableEditor GetRuleHandle

Retrieves a tblIRule command object corresponding to the rule ID queried.

Syntax

tblITableEditor_handle GetRuleHandle iRule ruleid

Application

Tcl Query

Description

Gets a tblIRule command object corresponding to the rule ID queried.

Inputs

iRule
The rule handle to be set.
ruleid
The rule ID.

Example

set t [hw::GetT]
set activetableHandle [hwi GetActiveClientHandle ch$t]
set ruleid [$activetableHandle AddRule]
set ruleHandle [$activetableHandle GetRuleHandle rh$ruleid $ruleid]
$ruleHandle SetCellList "A1 A2 B1 B2"
$ruleHandle SetBackgroundColor 3
$ruleHandle SetTextColor 0
$ruleHandle SetValue 10
$ruleHandle SetOperator ">"
$ruleHandle ReleaseHandle
set ruleids [$activetableHandle GetRuleIdsActingOnCell "A2"]
puts "Rule ids: $ruleids act on cell A2"
$activetableHandle ReleaseHandle

Errors

Returns success(0) or an error code.