The set_user_property function defines a value for a specified parameter or variable that will be stored in memory. The parameter and its value are subsequently saved to the arbortext.wcf preferences file when the Arbortext Editor session exits. When Arbortext Editor exits, all parameters specified by set_user_property are saved to the user's preferences file. The next time Arbortext Editor starts, these parameters and their values will be loaded into memory. A custom application can call this function anytime during a Arbortext Editor session.

To avoid conflicts with other applications that may be using the same memory during a Arbortext Editor session, use a unique qualified name (following the Java class naming convention) for the key parameter. For example, the key name could be something like com.arbortext.sample.Verbose, where com.arbortext.sample is the Java class for the application, and Verbose is the specific property.

The value parameter can be any value, including an empty string.

The function returns any previous value associated with the specified key. This function will return an empty string if there is either no previous value or the previous value is an empty string.

Use the get_user_property function to retrieve a parameter and its associated value.

When Arbortext Editor starts, it loads these values into memory before processing the custom and application directories. This action makes the parameters available during the initialization phase of a custom application.