This function shows a simple text input dialog
at a specified location in the project client/viewer.
Syntax
ShowInplaceInput("tagOutput",numStartXPos,numStartYPos { | ,optNumMin,optNumMax { | , { optNumEnablePasswordMode |
0 | 1 } { | , { optNumShowOSVK |
0 | 1 } } } } )
- tagOutput
- The name of a tag that will receive the input.
Note: The tag
name must be enclosed in quotes, as shown in the syntax diagram, or
else the project will try to get the value of the named
tag.
- numStartXPos
- The starting X position of the top-left corner of
the input dialog — that is, the number of pixels between that
corner and the left side of the display.
- numStartYPos
- The starting Y position of the top-left corner of
the input dialog — that is, the number of pixels between that
corner and the top of the display.
- optNumMin
- The minimum numeric value that will be accepted
by the input dialog.
This is an optional parameter. If no value is
specified, then the dialog will accept any value.
- optNumMax
- The maximum numeric value that will be accepted
by the input dialog.
This is an optional parameter. If no value is
specified, then the dialog will accept any value.
- optNumEnablePasswordMode
- An option to enable password mode, which
obfuscates the operator's input as if it's a password:
|
Value |
Description |
| 0
|
Show input
as plain text. |
| 1
|
Obfuscate
input. |
This is an optional parameter. If no value is
specified, then the default is 0.
- optNumShowOSVK
- An option to show the default Virtual Keyboard,
which is configured in the project
settings:
|
Value |
Description |
| 0
|
Do not show
Virtual Keyboard. |
| 1
|
Show Virtual
Keyboard. |
This is an optional parameter. If no value is
specified, then the default is 0.
Returned value
This function returns the following possible values:
|
Value |
Description |
| 0
|
Success. |
| -1
|
Invalid tag
specified for tagOutput. |
| -2
|
Invalid
number of parameters. |
| -3
|
Viewer is
not running. |
Examples
ShowInplaceInput( "OperatorInput", 50, 50 )
ShowInplaceInput( "OperatorInput", 50, 50, 1, 100 )
ShowInplaceInput( "OperatorInput", 50, 50, 1, 100, 0, 1 )