StatusBarProgressMeter

Manipulates Rhino's status bar progress meter.

Syntax

Start, or show, the progress meter.

Rhino.StatusBarProgressMeter (strLabel, intLower, intUpper [, blnEmbedLabel [, blnShowPercent]])

Set the current position of the progress meter.

Rhino.StatusBarProgressMeter (intPosition [, blnAbsolute])

End, or hide, the progress meter.

Rhino.StatusBarProgressMeter ()

Parameters

strLabel

Required.  String.  A short description of the progress. (e.g. "Calculating", "Meshing", etc.)

intLower

Required.  Number.  The lower limit of the progress meter's range.

intUpper

Required.  Number.  The upper limit of the progress meter's range.

blnEmbedLabel

Optional.  Boolean.  If True (Default), then the label will be embedded in the progress meter. If False, then the label will appear to the left of the progress meter.

blnShowPercent

Optional.  Boolean.  If True (Default), then the percent complete will appear in the progress meter.

intPosition

Required.  Number.  The new position of the progress meter.

blnAbsolute

Optional.  Number.  If True (Default), then the progress meter is moved to intPosition (absolute). If False, then the progress meter is moved intPosition from the current position (relative).

(empty)

Ends, or hides, the progress meter.

Returns

Boolean

If starting, or showing, the progress bar, the True or False indicating success or failure.

Number

If setting the position of the progress bar, then the previous position if successful.

Null

If ending, or closing, the progress meter, or on error.

Example

Sub TestStatusBarProgressMeter

  Dim nLower, nUpper, i

  nLower = 0

  nUpper = 100

  Rhino.StatusBarProgressMeter "Solving", 0, 100

  For i = nLower to nUpper

    Rhino.Print i

    Rhino.StatusBarProgressMeter i

    Rhino.Sleep 500

  Next

  Rhino.StatusBarProgressMeter

End Sub

Also See

Print

MessageBox