ProgressDialog

This object represents a window showing a progress bar.

Constructor function.

var myObject = new ProgressDialog();

var myObject = new ProgressDialog(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
   • value - (integer) the value
   • labelText - (string) the label text
   • minimum - (integer) the minimum value
   • maximum - (integer) the maximum value
   • range - (object) the range
     • minimum - (integer) the minimum value
     • maximum - (integer) the maximum value
   • onCanceled - (OnCanceled) event called when the window is canceled

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

var myObject = new ProgressDialog();

var myObject = new ProgressDialog({
	title: "Please wait",
	value: 50
});

Sets the window's title.

myObject.setTitle(title);

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

• (ProgressDialog) this ProgressDialog

Sets the window's position.

myObject.setPosition(point);

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

• (ProgressDialog) this ProgressDialog

Sets the window's opacity.

myObject.setOpacity(opacity);

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

• (ProgressDialog) this ProgressDialog

Sets the window's enabled status.

myObject.setEnabled(enabled);

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

• (ProgressDialog) this ProgressDialog

Sets the window's visible status.

myObject.setVisible(visible);

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

• (ProgressDialog) this ProgressDialog

Closes the window.

myObject.close();

• (ProgressDialog) this ProgressDialog

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 progress value.

myObject.setValue(value);

1. value - (integer) the progress value

• (ProgressDialog) this ProgressDialog

Sets the label text.

myObject.setLabelText(labelText);

1. labelText - (string) the label text

• (ProgressDialog) this ProgressDialog

Sets the minimum value.

myObject.setMinimum(minimum);

1. minimum - (integer) the minimum value

• (ProgressDialog) this ProgressDialog

Sets the maximum value.

myObject.setMaximum(maximum);

1. maximum - (integer) the maximum value

• (ProgressDialog) this ProgressDialog

Sets the minimum and maximum value.

myObject.setRange(minimum, maximum);

1. minimum - (integer) the minimum value
2. maximum - (integer) the maximum value

• (ProgressDialog) this ProgressDialog

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

myObject.show();

• (ProgressDialog) this ProgressDialog

Show the window. (blocking)

myObject.showModal();

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

Called when the window is canceled.

myObject.onCanceled = function() {};

myObject.onCanceled = function()
{
	//Event action
};

The window's title. (string)

The window's position. (Point)

The window's opacity. (float)

The window's enabled status. (boolean)

The progress bar's value. (integer)