| Built-in front calls / Built-in front calls | |
Standard front call functions provide common utility APIs to control the front-end.
This table shows the functions implemented by the front-ends in the "standard" module, available on all front-ends.
| Function Name | Description | GDC | GWC-JS | GMA | GMI |
|---|---|---|---|---|---|
ui.Interface.frontCall("standard", "cbAdd",
[text], [result])
|
Adds to the content of the clipboard. | Yes | No | No | No |
ui.Interface.frontCall("standard", "cbClear",
[], [result])
|
Clears the content of the clipboard. | Yes | No | No | No |
ui.Interface.frontCall("standard", "cbGet",
[], [text])
|
Gets the content of the clipboard. | Yes | No | No | No |
ui.Interface.frontCall("standard", "cbPaste",
[], [result])
|
Pastes the content of the clipboard to the current field. | Yes | No | No | No |
ui.Interface.frontCall("standard", "cbSet",
[text], [result])
|
Set the content of the clipboard. | Yes | No | No | No |
ui.Interface.frontCall("standard", "execute",
[cmd,wait], [result])
|
Executes a command on the front-end platform, with or without waiting. | Yes | No | No | No |
ui.Interface.frontCall("standard", "feInfo",
[name], [result])
|
Queries general front-end properties. | Yes | Yes | Yes | Yes |
ui.Interface.frontCall("standard", "getEnv",
[name], [value])
|
Returns an environment variable set in the user session on the front end platform. | Yes | No | No | No |
ui.Interface.frontCall("standard", "getWindowId",
[aui-win-id], [loc-win-id])
|
Returns the local window manager identifier of the window corresponding to the AUI window id passed as parameter. | Yes | No | No | No |
ui.Interface.frontCall("standard", "hardCopy",
[pgsize], [result])
|
Prints a screen shot of the current window | Yes | No | No | No |
ui.Interface.frontCall("standard", "launchURL",
[ url [, mode ] ], [] )
|
Opens an URL with the default URL handler of the front-end. | Yes | Yes | Yes | Yes |
ui.Interface.frontCall("standard", "mdClose",
[name], [result])
|
Unloads a DLL or shared library front call module. | Yes | No | No | No |
ui.Interface.frontCall("standard", "openDir",
[path,caption], [result])
|
Displays a file dialog window to get a directory path on the local file system. | Yes | No | No | No |
ui.Interface.frontCall("standard", "openFile",
[path,name,wildcards,caption],
[result])
|
Displays a file dialog window to get a path to open a file on the local file system. | Yes | Yes | No | No |
ui.Interface.frontCall("standard", "playSound",
[filename], [])
|
Plays the sound file passed as parameter on the front-end platform. | Yes | Yes | Yes | Yes |
ui.Interface.frontCall("standard", "saveFile",
[path,name,filetype,caption],
[result])
|
Displays a file dialog window to get a path to save a file on the local file system. | Yes | No | No | No |
ui.Interface.frontCall("standard", "setReportFont",
[font], [result])
|
Override the font used for report generation for the current application. | Yes | No | No | No |
ui.Interface.frontCall("standard", "setReportPrinter",
[printer], [result])
|
Override the printer configuration used for report generation for the current application. | Yes | No | No | No |
ui.Interface.frontCall("standard", "setWebComponentPath",
[path], [])
|
Defines the base path where web components are located. | Yes | N/A | Yes | Yes |
ui.Interface.frontCall("standard", "shellExec",
[document, action], [result])
|
Opens a file on the front-end platform with the program associated to the file extension. | Yes | No | No | No |