system.vision.isTouchscreenMode

Backwards Compatibility

This function replaces system.gui.isTouchscreenModeEnabled. Any scripts containing Vision Client scoped functions that were replaced with system.vision syntax will still work to maintain backwards compatibility. Only the system.vision variations will appear in the Script Editor's autocomplete popup.

This function is used in Python Scripting.

Description

Checks whether or not the running Client's Touch Screen mode is currently enabled.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.vision.isTouchscreenMode()

Parameters

Nothing

Returns

Boolean - True if the Client currently has Touch Screen mode activated.

Scope

Vision Client

Code Examples

Example #1

# This example is used in the Client Startup script to check if this Client is being run on a touch screen computer (judged by an IP address) and set Touch Screen mode.
  
ipAddress = system.net.getIpAddress()
query = "SELECT COUNT(*) FROM touchscreen_computer_ips WHERE ip_address = '%s' "
isTouchscreen = system.db.runScalarQuery(query %(ipAddress))
if isTouchscreen and not system.vision.isTouchscreenMode():
   system.vision.isTouchscreenMode(1)