---
title: "system.gui.showTouchscreenKeyboard"
description: "Displays a modal on-screen keyboard, allowing for arbitrary text entry using the mouse, or a finger on a touchscreen monitor."
---

# system.gui.showTouchscreenKeyboard

> Displays a modal on-screen keyboard, allowing for arbitrary text entry using the mouse, or a finger on a touchscreen monitor.

This function is used in **Python Scripting**.

## Description
Displays a modal on-screen keyboard, allowing for arbitrary text entry using the mouse, or a finger on a touchscreen monitor. Returns the text that the user "typed".

## Client Permission Restrictions
This scripting function has no [Client Permission](projects\project-properties\project-properties.md#client---permissions) restrictions.

## Syntax
`system.gui.showTouchscreenKeyboard(initialText [, fontSize] [, passwordMode])`

### Parameters

|Type|Parameter|Description|
|--|--|--|
|String| `initialText`| The text to start the on-screen keyboard with.|
|int |`fontSize` | The font size to display in the keyboard. [optional]|
|boolean|`passwordMode`| True (1) to activate password mode, where the text entered isn't echoed back clear-text. [optional]|
### Returns
**String** - The text that was "typed" in the on-screen keyboard.
### Scope
Client

## Code Examples
```python title="Example #1"
# This function is a holdover for backwards compatibility. Input components now know when the client is in touchscreen mode and respond accordingly. 
# This would go in the MouseClicked or MousePressed action of a Text Field or similar component.
  
if system.gui.isTouchscreenModeEnabled():
   event.source.text = system.gui.showTouchscreenKeyboard(event.source.text)
```