---
title: "Keyboard (Basic)"
canonical: "https://docs.cuesystem.com/space/CVCGC/407764996/Keyboard%20(Basic)"
format: markdown
---
> Macro (toc)

---

# Description

The keyboard is a fifty-six-key alphanumeric keypad. Input characters are displayed in the display area. If the button Enter is pressed the event is raised. The event delivers input characters as text. Every time any button has been pushed the event OnKeyPress is raised and it delivers the button code. The keyboard is available in two sizes - 800 x 344 and 640 x 275 pixels.

![image](media://b077fe4c-1e05-4039-bea7-a86a74c25e43)

# Properties

See section [https://cue.atlassian.net/wiki/spaces/CVCGC/pages/401178660/BasicKeyboards+Collection#Common-Properties](https://cue.atlassian.net/wiki/spaces/CVCGC/pages/401178660/BasicKeyboards+Collection#Common-Properties) . In addition, this object uses the following properties.

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Keyboard |
| SmallSize | Boolean | Yes = 640 x 275 pixels   
No = 800 x 344 pixels | No | This property switches size between small size (640 x 275 pixels) and full size (800 x 344 pixels). |
| PasswordMask | Boolean | Yes   
No | False | If Yes the input characters are masked by symbol *. |

# Functions

See section [https://cue.atlassian.net/wiki/spaces/CVCGC/pages/401178660/BasicKeyboards+Collection#Common-Functions](https://cue.atlassian.net/wiki/spaces/CVCGC/pages/401178660/BasicKeyboards+Collection#Common-Functions) . In addition, this object uses the following functions.

## SetPasswordMask 

This function sets property PasswordMask to newpasswordmask value. Function returns True.

#### Syntax

```visualbasic
Function SetPasswordMask(newpasswordmask As Boolean) As Boolean
```

## GetPasswordMask

This function returns the current value of property PasswordMask.

#### Syntax

```visualbasic
Function GetPasswordMask() As Boolean
```

# Events

## OnEnter 

This event is raised whenever button Enter is pushed. It returns input text in the parameter keyboardtext and id which was set by function ShowObject.

#### Syntax

```visualbasic
Event OnEnter As Process(keyboardtext As Text, ID As Long)
```

## OnKeyPress

This event is raised whenever any button is pushed. It returns key in the parameter keytext and id which was set by function ShowObject.

Parameter keytext returns

- “\0008” for button Backspace
- “\0009” for button Tab
- Printable characters for rest of buttons

#### Syntax

```visualbasic
Event OnKeyPress As Process(keytext As Text, ID As Long)
```