• Reference Guide

State Objects

Some dispels, mainly editors, publish so called state object to tools. A state object contains information about the state of the dispel that published it. Tools can use this information both to show details on editing to the user, and to affect the editing, as any change made in the state object is immediately reflected in the state of the editor. For instance, text editors have in its state object a data item that contains the line number at which the cursor is located. Creating a tool that edits this data item enables to display the cursor position and, in addition, to move the cursor by editing the value stored in the data item.
The following table summarizes the dispels that publish a state object. The identifiers under which the state object is published is also listed.
Dispel Class
State Object Identifier
(only when a formatted string is edited)