Editbox.ShowKeypad
The EditBox Control Object that is returned by the AddEditBox function has a ShowKeypad property. The Showkeypad property determines whether an alphanumeric keyboard is made available for the Edit Box. The keyboard is an on-screen keyboard display.
When the keyboard is shown, users can use it to enter numbers and letters in fields and so on, instead of using a traditional mouse and keyboard.
There are two types of on-screen keyboard:
- Alphanumeric keyboard—containing many of the letters, numbers and symbols that you would find on a traditional keyboard. This is the keyboard that is shown when the ShowKeypad property is used and the SetRange method is not set. The keyboard type and layout is determined by the user's Locale (see Define the Regional Settings for a User in the ClearSCADA Guide to Security).
- Numeric keypad—containing numeric keys (and related keys) only. Letters are unavailable. This is the keypad that is shown when the ShowKeypad property is used and the SetRange method is set (see EditBox.SetRange).
Syntax |
ControlObject.ShowKeypad = Value Where ControlObject. is the name of the variable (declared in your script) that is used to store the EditBox Control Object that is returned by the AddEditBox function. |
Description |
Provides access to an on-screen keyboard for manual entry of values. |
Arguments |
Value {Boolean} If set to True (1), the Edit box provides access to a keyboard; if set to False (0) the EditBox does not provide access to a keyboard and any user-defined inputs have to be made manually. |
Returns |
Boolean |
Example:
EditBox1.ShowKeypad = 1
Where:
- EditBox1 is the name of the variable that stores the EditBox Control Object returned by the AddEditBox function
- 1 sets the Edit Box to have an alphanumeric keyboard.