Version: 8.3

system.vision

Vision Functions

The following functions will allow you to update your Vision Client project using scripting, control windows, and create popup interfaces.

📄️ beep

Tells the computer where the script is running to make a "beep" sound.

📄️ centerWindow

Given a window path, or a reference to a window itself, it will center the window.

📄️ closeDesktop

Allows you to close any of the open desktops associated with the current client.

📄️ closeParentWindow

Closes the parent window given a component event object.

📄️ closeWindow

Given a window path, or a reference to a window itself, it will close the window.

📄️ color

Creates a new color object, either by parsing a string or by having the RGB[A] channels specified explicitly.

📄️ createImage

Takes a snapshot of a component and creates a Java BufferedImage out of it.

📄️ createPopupMenu

Creates a new popup menu, which can then be shown over a component on a mouse event.

📄️ createPrintJob

Provides a general printing facility for printing the contents of a window or component to a printer.

📄️ desktop

Allows for invoking system.vision functions on a specific desktop.

📄️ exit

Exits the running Client, as long as the shutdown intercept script doesn't cancel the shutdown event.

📄️ exportCSV

Exports the contents of a dataset as a CSV file, prompting the user to save the file to disk.

📄️ exportExcel

Exports the contents of a dataset as an Excel spreadsheet, prompting the user to save the file to disk.

📄️ exportHTML

Exports the contents of a dataset to an HTML page. Prompts the user to save the file to disk.

📄️ findWindow

Finds and returns a list of windows with the given path.

📄️ getAvailableLocales

Returns a collection of the locales defined on the system, as strings.

📄️ getAvailableTerms

Returns a collection of available terms defined in the translation system.

📄️ getClientId

Returns a hex-string that represents a number unique to the running Client's session.

📄️ getConnectionMode

Retrieves this Client session's current connection mode.

📄️ getConnectTimeout

Returns the connect timeout in milliseconds for all Client-to-Gateway communication.

📄️ getCurrentDesktop

Returns the handle of the desktop this function was called from.

📄️ getCurrentWindow

Returns the path of the current "main screen" window, which is defined as the maximized window.

📄️ getDesktopHandles

Gets a list of all secondary handles of the open desktops associated with the current client.

📄️ getEdition

Returns the edition of the Vision Client.

📄️ getExternalIpAddress

Returns the Client's IP address, as it is detected by the Gateway.

📄️ getGatewayAddress

Returns the address of the Gateway that the Client is currently communicating with.

📄️ getInactivitySeconds

Returns the number of seconds since any keyboard or mouse activity.

📄️ getKeyboardLayouts

Returns a list of keyboard layouts available on this system.

📄️ getLocale

Returns the current string representing the user's Locale, such as 'en' for English.

📄️ getOpenedWindowNames

Finds all of the currently open windows and returns a tuple of their paths.

📄️ getOpenedWindows

Finds all of the currently open windows and returns a tuple of references to them.

📄️ getParentWindow

Finds the parent (enclosing) window for the component that fired an event and returns a reference to it.

📄️ getReadTimeout

Returns the read timeout in milliseconds for all client-to-gateway communication.

📄️ getRoles

Finds the roles that the currently logged in user has, returns them as a Python tuple of strings.

📄️ getScreenIndex

Returns an integer value representing the current screen index based on the screen from which this function was called.

📄️ getScreens

Get a list of all the monitors on the computer this client is open on.

📄️ getSibling

Given a component event object, looks up a sibling component.

📄️ getSystemFlags

Returns an integer that represents a bit field containing information about the currently running system.

📄️ getUsername

Returns the currently logged-in username.

📄️ getWindow

Finds a reference to an open window with the given name.

📄️ getWindowNames

Returns a list of the paths of all windows in the current project, sorted alphabetically.

📄️ goBack

When using the Typical Navigation Strategy, this function will navigate back to the previous main screen window.

📄️ goForward

Navigates "forward" to the last main-screen window the user was on when they executed a system.vision.goBack().

📄️ goHome

When using the Typical Navigation Strategy, this function will navigate to the "home" window.

📄️ invokeLater

Invokes (calls) the given Python function object after all of the currently processing and pending events are done being processed, or after a specified delay.

📄️ isOverlaysEnabled

Returns whether or not the current client's quality overlay system is currently enabled.

📄️ isScreenLocked

Returns whether or not the screen is currently locked.

📄️ isTouchscreenMode

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

📄️ lockScreen

Used to put a running client in lock-screen mode.

📄️ logout

Logs out of the client for the current user and brings the client to the login screen.

📄️ openDesktop

Creates an additional Desktop in a new frame.

📄️ openFile

Shows an Open File dialog box, prompting the user to choose a file to open.

📄️ openFiles

Shows an Open File dialog box, prompting the user to choose a file or files to open.

📄️ openURL

Opens the given URL or URI scheme outside of the currently running Client in whatever application the host operating system deems appropriate.

📄️ openWindow

Opens the window with the given path.

📄️ openWindowInstance

Operates exactly like system.vision.openWindow, except that if the named window is already open, then an additional instance of the window will be opened.

📄️ playSoundClip

Plays a sound clip from a wav file to the system's default audio device.

📄️ printToImage

This function prints the given component (such as a graph, container, entire window, etc) to an image file, and saves the file where ever the operating system deems appropriate.

📄️ refreshBinding

This function will programmatically cause a SQL Query or DB Browse property binding to execute immediately.

📄️ retarget

This function allows you to programmatically 'retarget' a Vision Client to a different project and/or different Gateway.

📄️ saveFile

Prompts the user to save a new file named filename.

📄️ setConnectionMode

Sets the connection mode for the Client session.

📄️ setConnectTimeout

Sets the connect timeout for Client-to-Gateway communication.

📄️ setLocale

Sets the user's current Locale.

📄️ setOverlaysEnabled

Enables or disables the component quality overlay system.

📄️ setReadTimeout

Sets the read timeout for Client-to-Gateway communication.

📄️ setScreenIndex

Moves an open client to a specific monitor.

📄️ setTouchscreenMode

Alters a running Client's Touch Screen mode on the fly.

📄️ showColorInput

Prompts the user to pick a color using the default color-chooser dialog box.

📄️ showConfirm

Displays a confirmation dialog box to the user with Yes and No options, and a custom message.

📄️ showDiagnostics

Opens the client runtime diagnostics window, which provides information regarding performance, logging, active threads, connection status, and the console.

📄️ showError

Displays an error-style message box to the user.

📄️ showInput

Opens up a popup input dialog box.

📄️ showMessage

Displays an informational-style message popup box to the user.

📄️ showNumericKeypad

Displays a modal on-screen numeric keypad, allowing for arbitrary numeric entry using the mouse, or a finger on a touchscreen monitor.

📄️ showPasswordInput

Pops up a special input box that uses a password field, so the text isn't echoed back in clear-text to the user.

📄️ showTouchscreenKeyboard

Displays a modal on-screen keyboard, allowing for arbitrary text entry using the mouse, or a finger on a touchscreen monitor.

📄️ showWarning

Displays a message to the user in a warning style popup dialog.

📄️ swapTo

Performs a window swap from the current main screen window to the window specified.

📄️ swapWindow

Performs a window swap.

📄️ switchUser

Attempts to switch the current user on the fly.

📄️ transform

Sets a component's position and size at runtime.

📄️ unlockScreen

Unlocks the client, if it is currently in lock-screen mode.

📄️ updateProject

Updates the Vision Client project with saved changes.

Functions by Scope

Gateway

logout

Vision

Perspective

logout

Constants

system.vision.ACCL_NONE
system.vision.ACCL_CONSTANT
system.vision.ACCL_FAST_TO_SLOW
system.vision.ACCL_SLOW_TO_FAST
system.vision.ACCL_EASE
system.vision.COORD_SCREEN
system.vision.COORD_DESIGNER
system.vision.CONNECTION_MODE_DISCONNECTED
system.vision.CONNECTION_MODE_READ_ONLY
system.vision.CONNECTION_MODE_READ_WRITE
system.vision.DESIGNER_FLAG
system.vision.PREVIEW_FLAG
system.vision.CLIENT_FLAG
system.vision.WEBSTART_FLAG
system.vision.APPLET_FLAG
system.vision.FULLSCREEN_FLAG
system.vision.SSL_FLAG
system.vision.MOBILE_FLAG
system.vision.LANDSCAPE
system.vision.PORTRAIT

Vision Functions​