HS4Touch Properties
Documentation on using the HS4Touch Designer Properties
Overview
HS4Touch Screens, Elements and Devices are defined by the following properties.
See HS4Touch Quick Start Guide for more context on using properties.
Variables
This feature is new for HS4Touch. For many properties you can now use a variable name instead of an explicit reference. Variable names are in the format [#name]. A new action is available that allows for the setting of the variable.
For example, a label may reference a device so it displays the device's status. The Status Tracking property can be set to a variable such as [#light1]. A button can then have an action when released to set the variable "light1" to a specific device. The label will now display the status for this new device.
This feature will allow you to create less screens. You can have a screen with many labels for a collection of devices and then have buttons that change all the references when selecting different rooms. Another example is a screen that shows one camera. This screen can have buttons for all your other cameras and clicking each button changes the displayed camera. This avoids maintaining a screen for each camera. In this case the "Camera" property on an image element would be set to a variable.
Not all element properties support variables. When you click on an element property the description at the bottom of the properties pane will include a note if the property supports a variable.
When your project first starts all variable values are blank. It may be desirable to set defaults. In the Designer there is a dialog named "Edit Variables" off the Tools menu which allows you to set the default values. Default values may be the default label for a button, the default camera name for an image, or the reference ID for a device reference. As you add variables to element properties, this dialog will automatically update.
Note that you can use variables anywhere you could have previously used replacement variables. For example, in any element label, URL, or script command or script parameter.
Actions
| Property | Description |
|---|---|
| ActionsWhenPressed | Sets the actions performed when element is pressed. |
ActionsWhenReleased | Sets the actions performed when element is released. |
| ActionsWhenSelectionChanged | Sets the actions performed when selection changes. |
HonorAllReleases | If TRUE then all element release actions are executed even if a user slid their finger off an element then released. Enable this for cases where the press action starts an action (such as raising the volume) and the release stops the action. You want the release action to always be executed even if the selection is no longer on the element. When False, the release actions are not executed when a user selects an element but changes their mind and slides their finger off the element. This property is only available for the label element (buttons or text elements). |
| IgnorePresses | Set to 'true' to ignore presses on this element. Use for graphics, text and labels. |
Appearance
| Property | Description |
|---|---|
BorderStyle | Sets the border style for this element. |
| Camera | Sets an image element to a camera view for any camera connected to your HS4 system. NEW for HS4Touch |
ColorBackground | Sets the background color for this screen. |
ColorNormal | Sets the normal background color for this element. |
ColorPressed | Sets the pressed background color for this element. |
FontColorNormal | Sets the normal font color for this element. |
FontColorPressed | Sets the pressed font color for this element. |
FontNormal | Sets the normal font for this element. |
FontPressed | Sets the pressed font for this element. |
ImageBackground | Sets the background image for this screen. |
ImageFormat | Sets the image format for this element. 'Normal' displays the image at its original size and proportion; 'Stretched' automatically resizes the image to fit the element. |
ImageNormal | Sets the normal image for this element (from local PC or network). |
ImagePressed | Sets the pressed image for this element (from local PC or network). |
ImageURLNormal | Sets the normal image for this element (from internet URL). |
ImageURLPressed | Sets the pressed image for this element (from internet URL). |
PointerImage | Sets the pointer image for this element. (slider element only) |
Text | Sets the text label for this element. HomeSeer script statements can also be entered here to display specific information. For example, the HomeSeer HSM100 motion sensor holds the temperature in the device value property. The temperature needs to be divided by 10 to get the actual temperature. If the temperature was 72.5 degrees, the value would be held as 725. To get HSTouch to display the proper temperature, use the HomeSeer script command "hs.DeviceValue(DEVICE)". If the HSM100 temperature device had a code of "Q1", just enter this in the HSTouch text property: [$SCRIPT=&hs.DeviceValue("Q1")/10] Note that script commands can only be added to the Text property of the Label element. See the HomeSeer scripting document for more information on all HomeSeer scripting commands. |
TextAlignment | Sets the text alignment for this element. |
Identification
| Property | Description |
|---|---|
Name | Sets the name for this element. |
ScreenTitle | The name of this screen. Will Be displayed in the title bar of the screen if the title bar is enabled in the project defaults. This is also used to reference this screen in the element actions. |
| Visible | Determines whether the element is visible or hidden |
Settings
| Property | Description |
|---|---|
AnimateDelay | When using an animation style, this is the speed in which the animation takes place. The value is in milliseconds. |
AnimateStyle | On Windows platforms, screens may be displayed using animation such as slide right, up or down, roll in, or fade in and out. Select the style you would like applied to the screen when it is displayed or hidden. |
DeviceTypes | If set, this screen will be used as a dedicated control screen for a specific device. When a user selects a device from the device list selector, a screen with a device type matching the target device is located and displayed. |
Height | The height of the screen in pixels. |
IsMain | When set to TRUE this screen is a main screen and is displayed when the HSTouch client is started. You can have multiple main screens. For example, a small screen across the top may be used as a menu bar and would have the IsMain set to TRUE so its always displayed when the system starts. |
Left | Where the left edge of the screen is located when its initially displayed on the screen. |
Marquee | Set to TRUE to have text scroll from left to right. The text will only scroll if it does not fit in the space allocated to it. When TRUE the text will not wrap, even if there is space to wrap the text. |
MarqueeIncrement | When Marquee is TRUE, this is the number of pixels that the text will scroll when the MarqueeSpeed time has expired. Use with MarqueeSpeed to obtain the desired text scroll speed. |
MarqueeSpeed | The update speed of the text in milliseconds. Use with MarqueeIncrement to obtain the desired text scroll speed. |
OffsetMax | Sets the offset (in pixels) from the top (or left) edge of the slider to the maximum position of the pointer image. Used for limiting the travel of the pointer image within the slider. |
OffsetMin | Sets the offset (in pixels) from the bottom (or right) edge of the slider to the minimum position of the pointer image. Used for limiting the travel of the pointer image within the slider. |
Orientation | Sets the element's orientation to 'Horizontal' or 'Vertical'. Used for progress bars and sliders. |
Passcode | Enter a numeric passcode to protect this screen. If nothing is entered here, the screen will be displayed without prompting the user for a passcode. If a passcode is entered, a small numeric keypad will be displayed allowing the user to enter the passcode. The user must enter the correct passcode in order for the desired screen to display. Use this feature to procted screens that may disarm a security panel. When this property is first set, the HSTouch Designer will automatically create a passcode screen for you using the template named Passcode.xml in the Custom pallette. It will look for the template under the currently selected skin. You may edit this screen after its added to the project to suit your needs. |
SmallChange | Used when the slider is non graphical. |
TickFrequency | How many tick marks are displayed when the slider is non graphical. |
TickStyle | The style of the tick marks when the slider is non graphical. |
Top | Where the top edge of the screen is located when its initially displayed on the screen. |
TrackRealtime | If 'True', sets the slider to function as a real time control. If 'False', passes slider values only when pointer is released. |
ValueInitial | Sets the initial value for this element. |
ValueInvert | Set to 'True' to invert the values for this element. |
ValueMax | Sets the maximum value returned by this element. This value is set automatically if associated with specific items of known value. |
ValueMin | Sets the minimum value returned by this element. This value is set automatically if associated with specific items of known value. |
Width | The width of the screen in pixels. |
LockToBackground | For an image element, the graphic may be locked to the background. Once this is set, the image may only be moved using the arrow keys. This setting causes the client to draw this image on the background. This speeds up rendering of the background and ensures that any transparent elements placed on this graphic are drawn properly. If this is enabled, the "Ignore Presses" property is always treated as TRUE and the element cannot detect presses. |
Status/Device Associations
| Property | Description |
|---|---|
StatusColors | If an element has a status text association set (using StatusTracking...) then this property will be available. Use this to assign a different background color, font color, or alternate text to an element. For example, you can assign a different background color to the element if a HomeSeer device is ON or OFF or DIM, or change the displayed text to "Light On" when the devices's status is set to ON. |
StatusImages | If an element has a status graphic association set (using StatusTracking...) then this property will be available. Use this to assign graphics to various status values. For example, you can assign different graphics to the element if a HomeSeer device is ON or OFF or DIM. |
StatusTracking | Sets the association of an element to a HomeSeer device, thermostat, music player or RSS data field for status and control. (Available only on slider elements) |
StatusTrackingNormal | Sets the association of a button element (in its normal state) to the status of a HomeSeer device, thermostat, music player or RSS data field. |
StatusTrackingPressed | Sets the association of a button element (in its pressed state) to the status of a HomeSeer device, thermostat, music player or RSS data field. |
Web
| Property | Description |
|---|---|
AllowNavigation | If the Text property is a URL, a browser is loaded into the element. Set this property to TRUE if you would like to allow the user to browse using any links that are displayed on the page. If FALSE, browsing is not allowed and the links are not active. On CE this property is ignored. (only available with the Text or Label element, or buttons) NEW for HS4Touch is an updated Edge browser control which can display any web page. |
IsHTML | If set to TRUE, the element will display any text in the Text property as HTML. This allows you to use HTML formatting for your displayed text. (only available with the Text or Label element, or buttons) |
Need more help?
- Get support by creating a ticket here
- Community Support