UserInterface.messageBox Method

Syntax

Python
C++

"userInterface_var" is a variable referencing a UserInterface object.

# Uses no optional arguments.
returnValue = userInterface_var.messageBox(text)

# Uses optional arguments.
returnValue = userInterface_var.messageBox(text, title, buttons, icon)

"userInterface_var" is a variable referencing a UserInterface object.

#include <Core/UserInterface/UserInterface.h>

// Uses no optional arguments.
returnValue = userInterface_var->messageBox(text);

// Uses optional arguments.
returnValue = userInterface_var->messageBox(text, title, buttons, icon);

Parameters

text

string

The message text to display in the dialog.

title

string

If the optional title argument is provided, it sets the title for the dialog, otherwise the script or add-in name is used.

This is an optional argument whose default value is "".

buttons

MessageBoxButtonTypes

The optional buttons array can be used to specify which buttons to display on the dialog. The first button provided is the default action. If buttons are not specified, the dialog will default to a single OK button.

This is an optional argument whose default value is MessageBoxButtonTypes.OKButtonType.

icon

MessageBoxIconTypes

The optional icon argument can be used to specify which icon to display, otherwise the default of no icon is used.

This is an optional argument whose default value is MessageBoxIconTypes.NoIconIconType.

Type	Description
DialogResults	The button pressed to dismiss the dialog is returned.

UserInterface.messageBox Method

Description

Syntax

Return Value

Parameters

Version

Name	Type	Description
text	string	The message text to display in the dialog.
title	string	If the optional title argument is provided, it sets the title for the dialog, otherwise the script or add-in name is used. This is an optional argument whose default value is "".
buttons	MessageBoxButtonTypes	The optional buttons array can be used to specify which buttons to display on the dialog. The first button provided is the default action. If buttons are not specified, the dialog will default to a single OK button. This is an optional argument whose default value is MessageBoxButtonTypes.OKButtonType.
icon	MessageBoxIconTypes	The optional icon argument can be used to specify which icon to display, otherwise the default of no icon is used. This is an optional argument whose default value is MessageBoxIconTypes.NoIconIconType.