Arbortext Command Language > Functions by Alphabetical Listing > preference
  
preference
preference (string[, factory])
This function returns the preference scope value of the set option specified by string, which may be an initial substring. This value is the value of the set option when Arbortext Editor is first started, which is also the .associated setting in the Preferences dialog box.
Set the optional boolean factory parameter to true to return the default value for the set option specified by string. The result is a string which may be passed to the set command.
* 
Boolean values return on or off.
Examples
$tgfntclr = preference("tagfontcolor");
if (preference("pagebreaktext",1) == "off") { ...}
* 
Not all set options are preferences. If the string parameter specifies a set option that is not a preference, the return value will be empty.
Related Topics
option_scope function
set command