This version is out of date, covering development from v5.0.0 to v5.12.2. It is maintained here only for inbound reference links from elsewhere.

Jump to the current version of aTbRef.

Tinderbox Icon


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Altered: 

 Function   [other Function type actions]

 Conditional Group   [operators of similar scope]

 Set & List creation   [other Set & List creation operators]

 Already in v5.0.0


A function collect_if() builds a List (prior to v5.6.0 it was a Set); see collect() for a related new operator.


builds a set by collecting all the notes corresponding to group, testing each note to see if it meets condition, and adding the value of the designated attribute to the set.

group may be any of {children,descendants,siblings,ancestors,all}. In addition, group may be argument that designates a particular (single) note other than this.

condition is a valid conditional test - i.e. it equates to true when matched.

attribute can be any expression, but is typically an attribute.

For example,


will construct a set of the names of all of this note's important children.

Note that collect_if's function is related to agents; many tasks you might perform with collect_if could be done as well, or better, with an agent.

If a list of unique values is required - i.e. a set rather than a list, simply pass the output to a Set attribute. Thus if:

$MyList = collect_if(children,$Age>6,$FavFruit) $MyList is "Apples;Oranges;Pears;Apples"

$MySet = collect(children,$Age>6,$FavFruit) MySet is "Apples;Oranges;Pears;"

Possible relevant notes (via "Similar Notes" feature):

A Tinderbox Reference File : Actions & Rules : Operators : Full Operator List : collect_if(group,condition,attribute)