Settings.set()
Overview
Sets a value for the specified property.
Format
Settings.set(setting,value);
| Parameter | Description | Type | Required |
|---|---|---|---|
| setting | The name of the property. See the Setting Values table for the names of properties that can be used. | String | Required |
| Setting values | Description | Notes |
|---|---|---|
|
autoSendScans |
Determines if data is automatically sent to a host after the cursor leaves a field. Values 1 and 2 are for scanned data only. Values 3 and 4 apply to scanned or typed input. Only for 5250 and 3270 emulation. |
Valid values: "0" = Do not auto send. "1" = Auto send after a barcode is scanned. "2" = Auto send the screen only if a barcode was scanned into the last field on the screen. "3" = Auto send the data when the cursor leaves a field. For example, when a user presses Tab and advances to the next field. "4" = Auto send the screen when leaving the last field on the screen. |
|
backEnabled |
(Web Only) Enables / Disables the back button on the context menu. |
"true" = Enabled. "false" = Disabled. |
|
backspaceKeySendsDelete |
Determines how the backspace key deletes characters. Only for VT emulation. |
Valid values: "true" = Backspace deletes character to the right of the cursor. "false" = Backspace deletes character to the left of the cursor. This is the default value. |
|
enterAsReset |
Determines whether <ENTER> key can be used as <RESET> key when the terminal is in an error state. Only for 5250 emulation. |
Valid values: "true" = Enabled. "false" = Disabled. This is the default value. |
|
enterKeySwapped |
Sets the ENTER key as the AS400 Enter key and the Field Exit key is moved to the previous Enter key location. Only for 5250 emulation. |
Valid values: "true" = Enabled. "false" = Disabled. This is the default value. |
|
forwardEnabled |
(Web Only) Enables or disables the forward button on the context menu. |
"true" = Enabled. "false" = Disabled. |
|
handleTelxon |
Determines whether Telxon escape sequences from the host are supported. Only for VT emulation. |
Valid values: "true" = Enabled. "false" = Disabled. This is the default value. |
|
hardwareRendering |
(Web Only) Determines whether the system will use hardware GL library rendering. Should only be turned to true to display web videos. |
Valid values: "true" = Enabled. "false" = Disabled. |
|
homeEnabled |
(Web Only) Enables or disables the home button on the context menu. |
"true" = Enabled. "false" = Disabled. |
|
hostMessageLine |
The message on the provided line will be shown as a toast message. Only for 5250 and 3270 emulation. If the value specified is more than the number of lines on the screen, then it will be reduced by 3 lines. For example, if this is set to 27 but the screen size is 80x24, line 24 is used as the host message. |
Valid values: "0" = Disabled. "1"-"27" = The row to show as a toast message. The default value is 27. |
|
incomingScreenBeep |
Determines whether beep is sounded when a new screen arrives from the host. Only for 5250 and 3270 emulation. |
Valid values: "true" = Enabled. This is the default value. "false" = Disabled. |
|
localEcho |
Specify if the terminal uses local echo to reflect what is sent to the host. Only for VT emulation. |
Valid values: "true" = Enabled. "false" = Disabled. This is the default value. |
|
oversizedScanning |
Determines how the Velocity Client handles scans with more characters than a field allows. Only for 5250 and 3270 emulation. |
Valid values: "1" = Truncate. Discards the extra characters. "2" = Split. Populates the current field and puts the extra characters into the next field. |
|
printColumn |
Indicates the column where the print start ID is found. This option is for 5250 and 3270 emulation types only. |
Valid values: zero-based integers. This value must be less than the maximum number of columns. Default value: 0 |
|
printEndId |
Determines the end ID for the print string. |
Valid values: any string with a maximum length of 70 characters. Default value: ":PRN" |
|
printRow |
Indicates the row where the print start ID is found. This option is for 5250 and 3270 emulation types only. |
Valid values: zero-based integers. This value must be less than the maximum number of rows. Default value: 2 |
|
printStartId |
Determines the start ID for the screen's print data. |
Valid values: any string with a maximum length of 70 characters. Default value: "PRN:" |
|
refreshEnabled |
(Web Only) Enables or disables the refresh button on the context menu. |
Valid values: "true" = Enabled. "false" = Disabled. |
|
retryWorkstationID |
Automatically appends a letter (starting with A) to the end of a workstation ID that is already in use. This should be set in the "beforeSession" scope. |
Valid values: "true" = Enabled. "false" = Disabled. This is the default value. |
|
screenUpdateOptimization |
Determines whether the Velocity Client tries to optimize the screen updates and only update the screen when a Get message is processed. Set this to "false" if you aren't seeing all the screen updates from the host. |
Valid values: "true" = Enabled. This is the default value. "false" = Disabled. |
|
specialTelxonScanTerminator |
Determines scan terminator which will be added after all scanned data in VT emulation. The special scan terminator is enabled by a Telxon escape sequence from the host. The "handleTelxon" option must be set to "true" in order to use a special scan terminator. |
Valid values: Any string up to 19 characters. |
|
vtLineMode |
Limits network traffic by batching key presses. |
added in 2.1.23 Valid values: "true" = Enabled. "false" = Disabled. This is the default value. |
Example 1
/* The Oversized Scanning property is set to truncate scanned
* items.
*/
Settings.set("oversizedScanning","1");Example 2
/* Setting backspaceKeySendsDelete to true so that pressing the backspace
* button will delete the character on the right side of the cursor.
*/
Settings.set("backspaceKeySendsDelete","true");