ShowInplaceInput

ShowInplaceInput shows a simple input box at a specified position on the project thin client.

Syntax

ShowInplaceInput("strOutputTag", numStartXPos, numStartYPos, optNumMin, optNumMax, optNumEnablePasswordMode, optNumShowOSVK)

strOutputTag

The name of a project tag that will receive the input. The data type of the tag should be appropriate for the type of input that you want to get from the user. For example, an Integer tag cannot receive text input.

Note: If this parameter is enclosed in quotes, the string literal will be used. Otherwise, the value of the tag/expression will be used.

numStartXPos

The starting X position of the top-left corner of the input box — that is, the number of pixels between that corner and the left side of the thin client display.

This is the "starting" position because the user can move the input box after it is shown.

numStartYPos

The starting Y position of the top-left corner of the input box — that is, the number of pixels between that corner and the top of the thin client display.

This is the "starting" position because the user can move the input box after it is shown.

optNumMin

The minimum numeric value that will be accepted as input.

This parameter is optional; if no value is specified, any value will be accepted.

optNumMax

The maximum numeric value that will be accepted as input.

This parameter is optional; if no value is specified, any value will be accepted.

optNumEnablePasswordMode

An option to enable password mode, which obfuscates the operator's input as if it is a password:

This parameter is optional; if no value is specified, the default value is 0.

optNumShowOSVK

An option to show the operating system's virtual keyboard for user input:

This parameter is optional; if no value is specified, the default value is 0. Also, this parameter is relevant only when the thin client is running on an operating system that has a built-in virtual keyboard. It cannot be used to show the Edge HMI Virtual Keyboard.

Returned value

This function returns one of the following possible values:

Notes

If the Enforce Web functionality equivalence in local project screens option is selected in the project settings, this function cannot be called in VBScript Global Procedures, VBScript scripts (script groups), or other background tasks. This is because the function behaves differently depending on whether you view project screens locally (that is, on the same computer that hosts the project runtime) or remotely. For more information, see Preferences tab.

Examples

Show the input box at X 50, Y 50, and then save the input to the tag UserInput:

ShowInplaceInput("UserInput",50,50)

Show the input box at X 50, Y 50, and then save the input — which must be between 1 and 100 — to the tag UserInput:

ShowInplaceInput("UserInput",50,50,1,100)

Show the input box at X 50, Y 50 with the virtual keyboard, and then save the input — which must be between 1 and 100 — to the tag UserInput:

ShowInplaceInput("UserInput",50,50,1,100,0,1)