MMpy.GUI.message_box

Syntax

MMpy.GUI.message_box(message, format=MMpy.MessageBoxFormat.ok, icon=MMpy.MessageBoxIcon.exclamation)

Description

Create a message box dialog and returns the users selection.

Parameters

Name
Type
Description

message

str The message to display in the message box.

format 

MMpy.MessageBoxFormat (optional) The format of the message box.

icon

MMpy.MessageBoxIcon (optional) The icon on the message box.

Returns

Type
Description
MMpy.MessageBoxResult Returns the user's selection result.

See Also

MMpy.MessageBoxFormat

MMpy.MessageBoxIcon

MMpy.MessageBoxResult

Notes

This is a static class method.

Valid choices for format are:

  • MMpy.MessageBoxFormat.abort_retry_ignore
  • MMpy.MessageBoxFormat.ok
  • MMpy.MessageBoxFormat.ok_cancel
  • MMpy.MessageBoxFormat.retry_cancel
  • MMpy.MessageBoxFormat.yes_no
  • MMpy.MessageBoxFormat.yes_no_cancel

Valid choices for icon are:

  • MMpy.MessageBoxIcon.exclamation
  • MMpy.MessageBoxIcon.information
  • MMpy.MessageBoxIcon.question
  • MMpy.MessageBoxIcon.stop

Valid choices for the return value are:

  • MMpy.MessageBoxResult.abort
  • MMpy.MessageBoxResult.cancel
  • MMpy.MessageBoxResult.ignore
  • MMpy.MessageBoxResult.no
  • MMpy.MessageBoxResult.ok
  • MMpy.MessageBoxResult.retry
  • MMpy.MessageBoxResult.yes

Examples

if MMpy.GUI.message_box('Do you want to continue?', MMpy.MessageBoxFormat.yes_no, MMpy.MessageBoxIcon.question) == MMpy.MessageBoxResult.yes:
    process_data()

Resource ID

IDPH_GUI_MESSAGEBOX