IR Framework: ProgressBar.Value Property

IR Framework

ProgressBar.Value Method

Gets or sets the value of the ProgressBar object.

object.Value ([value])

Arguments

object: Required. Always the name of a ProgressBar object.
value: Optional. The value to which to set the property.

Return Value

The ProgressBar.Value property returns the current value of the ProgressBar.

Remarks

The portion of the ProgressBar that is filled is computed as Value / MaxValue.

When attemting to set the property value, it is good to check the return value to ensure that the value was set.

The following example illustrates the use of the Value property.

var dash = ActiveDocument.Sections["Dashboard"];
dash.pb0001 = new ActiveDocument.ProgressBar(dash);
with (dash.pb0001) {
	Left(300);
	Top(200);
	Height(32);
	Width(160);
	var iValue = Value(0);
	if (iValue == 0) {
		// success
	}
	MaxValue(100);
	Show();
	for (var i = 1; i <= dash.pb0001.MaxValue() / 2; i++) {
		var a = (new Date()).valueOf();
		while ((new Date()).valueOf() - a < 10) {
			DoEvents();
			DoEvents();
		}
		dash.pb0001.Value(i * 2);
	}
}

Applies To: