3.7.5.2 Break

LabTalk Object Type:

Utility

Construct a progress/information dialog box that is under scripting control.

Properties:

Property Access Description
break.abort Read only
numeric

1 = the user pressed the Cancel button. Otherwise, is 0.

break.max Read/write
numeric

Maximum value of the progress bar. Note: Must set this property value after using the break.open() method.

break.min Read/write
numeric

Minimum value of the progress bar. Note: Must set this property value after using the break.open() method.

break.style Read/write
numeric

0 = default, 1 = no progress bar, 2 = End button instead of a Cancel button.

Methods:

Method Description
break.close()

Close the progress/information dialog box.

break.open(message)

Open a progress/information dialog box. Message is displayed in the dialog box.

break.set(value)

Set the current value for the progress dialog box. Note: If you need a progress bar that shrinks, then you must precede every break.set() that causes shrinking with a break.set(break.min) to clear the progress bar.

break.setMsg(message, position)

Set message displayed in the progress dialog box. If position = 0, the message displays as title of the dialog box. If position = 1, the message displays in the middle center of the dialog box. If position = 2, the message displays at the top left of the dialog box. The system variable @PBN can be used to control whether overwrite of current progress box message is allowed. If @PBN = 1, overwrite is not allowed.

Minimum Origin Version Required: 8.5.1 SR0
English | Deutsch | 日本語