---
title: "system.gui.inputBox"
description: "Opens up a popup input dialog box."
---

# system.gui.inputBox

> Opens up a popup input dialog box.

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

## Description
Opens up a popup input dialog box. This dialog box will show a prompt message and allow the user to type in a string. When the user is done, they can click **OK** or **Cancel**. If OK is pressed, this function will return with the value that they typed in. If Cancel is pressed, this function will return the value None.

## Client Permission Restrictions
This scripting function has no [Client Permission](../../../ignition-modules/vision/vision-project-properties/vision-project-properties.md#vision-permissions-properties) restrictions.

## Syntax
`system.gui.inputBox(message, defaultText)`

### Parameters
Type | Parameter | Description 
------- | ------- | ------
String| `message` | The message to display for the input box. Will accept HTML formatting.
String| `defaultText` | The default text to initialize the input box with.

### Returns
**String** - The string value that was entered in the input box.

### Scope
Vision Client

## Code Examples
```python title="Example #1"
# In the mouseClicked event of a label, this allows the user to change the label's text.
  
txt = system.gui.inputBox("Enter text:", event.source.text)
if txt != None:
   event.source.text = txt
```