Differences

This shows you the differences between two versions of the page.

--- xtension_manual:editunitdisplay [2018/04/11 15:02] – Added Control Type In LIst for version 9.4 James Sentman
+++ xtension_manual:editunitdisplay [2023/02/13 14:52] (current) – external edit 127.0.0.1
@@ Line 19: / Line 19: @@
 \\
   * **Control Type In Lists** This sets the control type that you wish to display for this unit in any List windows or Web Remote Lists that it’s included in. The Toggle control is the default, other options are Buttons, Popup, Text Field and None. For a Popup control you must supply a comma separated list of the options that you wish to include in the popup. The value of the unit will select the corresponding entry in the list for display. Selecting a new popup value will set the value of the unit to it’s index. In the example above the Unit is an HVAC Mode unit with 3 valid values, 0 for off, 1 for heat and 2 for cool. Instead of having to remember that and set the value manually with this control you can select the text values from a popup and have the proper value be set. See [[xtension_manual:controllingunits|Controlling Unit From Lists]] for more info on using and configuring the Unit List Control Type. The control type was added in XTension version 9.4.
+By filling in the comma separated list of values you enable the ability to use enumerated values with the [[dictionary:unitinformation:setvalueof|Set Value]] command. When setting the value of the above example you would not have to remember that numerical index for the “cool” setting is 2. You could simply do a:
+<code>
+set value of “my unit name” to “cool”
+</code>
+and as long as the string you pass matches one of the comma separated values it will set it to the proper numerical value under the hood. If you set the value to a string that is not in the list an error will be logged and the value will default to -1. No applescript error will be returned however so your script will continue to run.
 \\