MessageBox

This object represents a window showing some text to the user.

Constructor function.

var myObject = new MessageBox();

var myObject = new MessageBox(parameters);

1. parameters - (object) window parameters
   • title - (string) the window's title
   • position - (Point) the window's position
   • opacity - (float) the window's opacity
   • enabled - (boolean) the window's enabled status
   • visible - (boolean) the window's visible status
   • text - (string) the text
   • detailedText - (string) the detailed text
   • informativeText - (string) the informative text (appended to text)
   • buttons - (StandardButton) a flag list of buttons
   • icon - (Icon) the number of decimals
   • defaultButton - (StandardButton) the default selected button
   • escapeButton - (StandardButton) the button pressed when pressing escape
   • onClosed - (OnClosed) event called when the window is closed

• (ParameterTypeError) incorrect parameter type
• (ParameterCountError) incorrect parameter count

var myObject = new MessageBox();

var myObject = new MessageBox({
	title: "Press yes or no",
	icon: MessageBox.Warning,
	buttons: MessageBox.Yes | MessageBox.No
});

Sets the window's title.

myObject.setTitle(title);

1. title - (string) the window's title

• (MessageBox) this MessageBox

Sets the window's position.

myObject.setPosition(point);

1. point - (Point) the window's position

• (MessageBox) this MessageBox

Sets the window's opacity.

myObject.setOpacity(opacity);

1. opacity - (float) the window's opacity

• (MessageBox) this MessageBox

Sets the window's enabled status.

myObject.setEnabled(enabled);

1. enabled - (boolean) the window's enabled status

• (MessageBox) this MessageBox

Sets the window's visible status.

myObject.setVisible(visible);

1. visible - (boolean) the window's visible status

• (MessageBox) this MessageBox

Closes the window.

myObject.close();

• (MessageBox) this MessageBox

Returns the window's title.

myObject.title();

• (string) the window's title

Returns the window's position.

myObject.position();

• (Point) the window's position

Returns the window's opacity.

myObject.opacity();

• (float) the window's opacity

Returns the window's enabled status.

myObject.enabled();

• (boolean) the window's enabled status

Returns the window's visible status.

myObject.visible();

• (boolean) the window's visible status

Sets the text.

myObject.setText(text);

1. text - (string) the text

• (MessageBox) this MessageBox

Sets the detailed text.

myObject.setDetailedText(detailedText);

1. detailedText - (string) the detailed text

• (MessageBox) this MessageBox

Sets the informative text (appended to text).

myObject.setInformativeText(informativeText);

1. informativeText - (string) the informative text

• (MessageBox) this MessageBox

Sets the buttons to use.

myObject.setButtons(buttons);

1. buttons - (StandardButton) the buttons to use (flag)

• (MessageBox) this MessageBox

Sets the icon to use.

myObject.setIcon(icon);

1. buttons - (Icon) the icon to use

• (MessageBox) this MessageBox

Sets the default selected button.

myObject.setDefaultButton(button);

1. button - (StandardButton) the default button

• (MessageBox) this MessageBox

Sets the button pressed when pressing the escape key.

myObject.setEscapeButton(button);

1. button - (StandardButton) the button pressed when pressing the escape key

• (MessageBox) this MessageBox

Adds a custom button.

myObject.addCustomButton(button, text);

1. button - (StandardButton) the standard button corresponding to this custom button
2. text - (string) the text of this button

• (MessageBox) this MessageBox

• (AddCustomButtonError) add custom button failed

Show the window. (non-blocking) Use the OnClosed event to know when the window has been closed.

myObject.show();

• (MessageBox) this MessageBox

Show the window. (blocking)

myObject.showModal();

• (integer) the window result (0 means that it has been canceled)

Called when the window is closed.

myObject.onClosed = function(result) {};

1. result - (integer) the window result (0 means that it has been canceled)

myObject.onClosed = function(result)
{
	if(result)
	{
		//Event action
	}
};

The window's title. (string)

The window's position. (Point)

The window's opacity. (float)

The window's enabled status. (boolean)

The window's visible status. (boolean)

A standard button.

1. Ok: an "ok" button
2. Open: an "open" button
3. Save: a "save" button
4. Cancel: a "cancel" button
5. Close: a "close" button
6. Discard: a "discard" button
7. Apply: an "apply" button
8. Reset: a "reset" button
9. RestoreDefaults: a "restore defaults" button
10. Help: a "help" button
11. SaveAll: a "save all" button
12. Yes: a "yes" button
13. YesToAll: a "yes to all" button
14. No: a "no" button
15. NoToAll: a "no to all" button
16. Abort: an "abort" button
17. Retry: a "retry" button
18. Ignore: an "ignore" button
19. NoButton: no button

This is a flag enumeration, this means that you can use multiple values using the | operator. Example :

myObject.setButtons(MessageBox.Yes | MessageBox.Save); //Show yes and save buttons

An icon.

1. NoIcon: no icon
2. Question: a question mark icon
3. Information: an information icon
4. Warning: a warning icon
5. Critical: a critical icon (error)