gui_util

Send commands to the gui client.

Available in:

Apps (win) Apps (char) Reportwriter RPC Standalone PL
X        

Syntax

void gui_util(cmd[,parameter])
int           cmd
expr          parameter

Description

Sends special commands to the DesignVision client. Commands are defined in dv.h:
Command Description Parameter
gui_util_call_parent Calls the DVJScall function with the supplied parameter. Parameter to pass to DVJScall().
gui_util_clr_keys Clears the keystroke stack. N/A
gui_util_clr_lastact Clears the last stacked action. N/A
gui_util_heartbeat Sets the heartbeat timeout value. Value in milliseconds
gui_util_help_winname Sets the help window name. Window name
gui_util_kill_cookie Removes the DVJS_COOKIE. N/A
gui_util_killwin_prompt Sets the kill window prompt. If set, then DVJS will open a prompt box when the user tried to close the window via Alt-F4 or the X. To reset, send the command with no parameter. String to display in the prompt
gui_util_string Sends a string to the evSendString handler (WPF) String to send
gui_util_tooltip Sets or resets the tooltip associated with the element(WPF) String with "element ID tooltip". If element ID is not given, then it defaults to 0. If element ID is higher than any matching element ID, then it defaults to the last element. For example,
gui_util(gui_util_tooltip,"This is a tooltip");
sets the first element's tooltip.
gui_util(gui_util_tooltip,"2 This is a tooltip");
sets the third element's tooltip.
gui_util_topmost Sets or resets the window to be topmost (WPF) True (1) or False (0)
gui_util_winicon Sets the name of the image to display as the window icon String with the imagename, either preloaded or a URI reference

Example

Prompt the user to set the browser heartbeat timeout value:
gui_util(gui_util_heartbeat,prompt("Heartbeat timeout -> "));