tblITableEditor GetRuleIds

Returns a list of all rule IDs present in the table client.

Syntax

tblITableEditor_handle GetRuleIds

Application

HyperWorks Tcl Query

Description

Gets the rule IDs corresponding to all rules that are currently being used for the conditional formatting of table cells and returns a list of rule IDs. For example, 1 2 3.

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 GetRuleIds]
puts "Ids of rules present in this table client: $ ruleids"
$activetableHandle ClearAllRules
set ruleids [$activetableHandle GetRuleIds]
puts "Ids of rules present in this table client: $ ruleids"
$activetableHandle ReleaseHandle

Errors

None.