This version is out of date, covering development from v9.0.0 to v9.3.0. It is maintained here only for inbound reference links from elsewhere. It is no longer actively updated.

Jump to the current version of aTbRef

Tinderbox v9 Icon

delete(item)


Operator Type: 

Operator Scope of Action: 

Operator Purpose: 

Operator First Added: 

Operator Altered: 

 Function   [other Function type actions]

 Group   [operators of similar scope]

 Data manipulation   [other Data manipulation operators]

 Baseline

 


delete(item)

Deletes the designated item note; the scope is group (or item). If the designated note does not exist, the expression has no effect and returns false, i.e. nothing happens: no deletion, no message of no deletion. If the designated note exists, it will be deleted and the expression returns its former path.

delete("Some note"); 

However, it is strongly suggesting using a path ($Path) for item and not just the note's title ($Name), thus:

delete("/The/path/to/Some note"); 

Avoid using this operator when possible. It can automatically delete notes you intended to create, and it can potentially saw off the branch you are standing on. In almost all circumstances, it is better to move the unwanted note to a container, and then to delete the note manually if you really need to delete it at all.

The delete() operator returns true if at least one note was deleted, and false otherwise.