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

---

# Description

The keyboard opens fullscreen. In this keyboard style, Properties does offer a palette of colors to customize the background, buttons, and color of text on buttons. Colors for Up and Down may differ. Buttons in this keyboard style have square corners.

![image](media://74ecef3b-2ecc-4ac4-a710-dfe7c7eb4388)

![image](media://696ca379-ae88-4b1e-a485-b810278daf90)

# Properties

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

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
| Property Name | Data Type | Allowed Values | Default Value | Description |
| Appearance |
| BackgroundColor | Long | Any | &H7Fffffff | Keyboard background color |
| Up |
| TextColorUp | Long | Any | _COLOR_WHITE | Button characters color |
| CloseIconColorUp | Long | Any | _COLOR_WHITE | Close symbol color |
| ButtonColorUp | Long | Any | COLOR_GREYDARK | Color of Button |
| ButtonCloseColorUp | Long | Any | COLOR_REDPASTEL | Color of Close Button |
| Down |
| TextColorDown | Long | Any | _COLOR_BLACK | Button characters color |
| CloseIconColorDown | Long | Any | _COLOR_BLACK | Close symbol color |
| ButtonColorDown | Long | Any | _COLOR_WHITE | Color of Button |
| ButtonCloseColorDown | Long | Any | _COLOR_WHITE | Color of Close Button |

# Functions

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

## SetBackgroundColor

This function sets keyboard background newbackgroundcolor. Function returns True.

#### Syntax

```visualbasic
Function SetBackgroundColor(newbackgroundcolor As Long) As Boolean
```

## GetBackgroundColor

This function returns BackgroundColor.

#### Syntax

```visualbasic
Function GetBackgroundColor() As Long
```

## SetButtonColorDown

This function sets ButtonColorDown to newbuttoncolordown. Function returns True.

#### Syntax

```visualbasic
Function SetButtonColorDown(newbuttoncolordown As Long) As Boolean
```

## GetButtonColorDown

This function returns ButtonColorDown.

#### Syntax

```visualbasic
Function GetButtonColorDown() As Long
```

## SetButtonColorUp

This function sets ButtonColorUp to newbuttoncolorUp. Function returns True.

#### Syntax

```visualbasic
Function SetButtonColorUp(newbuttoncolorup As Long) As Boolean
```

## GetButtonColorUp

This function returns ButtonColorUp.

#### Syntax

```visualbasic
Function GetButtonColorUp() As Long
```

## SetButtonCloseColorDown

This Function sets ButtonCloseDown to newclosebuttoncolordown. Function returns True.

#### Syntax

```visualbasic
Function SetButtonCloseColorDown(newclosebuttoncolordown As Long) As Boolean
```

## GetButtonCloseColorDown

This function returns ButtonCloseDown.

#### Syntax

```visualbasic
Function GetButtonCloseColorDown() As Long
```

## SetButtonCloseColorUp

This Function sets ButtonCloseUp to newclosebuttoncolorup. Function returns True.

#### Syntax

```visualbasic
Function SetButtonCloseColorUp(newclosebuttoncolorup As Long) As Boolean
```

## GetButtonCloseColorUp

This function returns ButtonCloseUp.

#### Syntax

```visualbasic
Function GetButtonCloseColorUp() As Long
```

## SetCloseIconColorDown

This funcion sets CloseIconColorDown to newcloseiconcolordown. Function returns True.

#### Syntax

```visualbasic
Function SetCloseIconColorDown(newcloseiconcolordown As Long) As Boolean
```

## GetCloseIconColorDown 

This function returns CloseIconColorDown.

#### Syntax

```visualbasic
Function GetCloseIconColorDown() As Long
```

## SetCloseIconColorUp

This funcion sets CloseIconColorUp to newcloseiconcolorup. Function returns True.

#### Syntax

```visualbasic
Function SetCloseIconColorUp(newcloseiconcolorup As Long) As Boolean
```

## GetCloseIconColorUp

This function returns CloseIconColorUp.

#### Syntax

```visualbasic
Function GetCloseIconColorUp() As Long
```

## SetTextColorDown

This function sets TextColorDown to newtextcolordown. Function returns True.

#### Syntax

```visualbasic
Function SetTextColorDown(newtextcolordown As Long) As Boolean
```

## GetTextColorDown

This function returns TextColorDown.

#### Syntax

```visualbasic
Function GetTextColorDown() As Long
```

## SetTextColorUp

This function sets TextColorUp to newtextcolorup. Function returns True.

#### Syntax

```visualbasic
Function SetTextColorUp(newtextcolorup As Long) As Boolean
```

## GetTextColorUp

This function returns TextColorUp.

#### Syntax

```visualbasic
Function GetTextColorUp() As Long
```

# Events

See section [https://cue.atlassian.net/wiki/spaces/CVCGC/pages/462651478/Common+Section+Keyboards#Events](https://cue.atlassian.net/wiki/spaces/CVCGC/pages/462651478/Common+Section+Keyboards#Events).