StatusBar

public static class StatusBar
Contains static methods to control the application status bar.

Methods

ClearMessagePane

#Since v5.0
public static void ClearMessagePane()
Removes the message from the message pane.

HideProgressMeter

#Since v5.0
public static void HideProgressMeter()
Ends, or hides, Rhino's status bar progress meter.

HideProgressMeter

#Since v6.12
[CLSCompliant(false)] public static void HideProgressMeter(uint docSerialNumber)
Ends, or hides, Rhino's status bar progress meter.
Parameters:
docSerialNumber (uint)The document runtime serial number.

SetDistancePane

#Since v5.0
public static void SetDistancePane(double distance)
Sets the distance pane to a distance value.
Parameters:
distance (double)The distance value.

SetMessagePane

#Since v5.0
public static void SetMessagePane(string message)
Sets the message pane to a message.
Parameters:
message (string)The message value.

SetNumberPane

#Since v6.0
public static void SetNumberPane(double number)
Sets the number pane to a number value
Parameters:
number (double)

SetPointPane

#Since v5.0
public static void SetPointPane(Point3d point)
Sets the point pane to a point value.
Parameters:
point (Point3d)The point value.

ShowProgressMeter

#Since v5.0
public static int ShowProgressMeter(int lowerLimit, int upperLimit, string label, bool embedLabel, bool showPercentComplete)
Starts, or shows, Rhino's status bar progress meter.
Parameters:
lowerLimit (int)The lower limit of the progress meter's range.
upperLimit (int)The upper limit of the progress meter's range.
label (string)The short description of the progress (e.g. "Calculating", "Meshing", etc)
embedLabel (bool)If true, then the label will be embedded in the progress meter. If false, then the label will appear to the left of the progress meter.
showPercentComplete (bool)If true, then the percent complete will appear in the progress meter.
Returns: 1 - The progress meter was created successfully. 0 - The progress meter was not created. -1 - The progress meter was not created because some other process has already created it.

ShowProgressMeter

#Since v6.12
[CLSCompliant(false)] public static int ShowProgressMeter(uint docSerialNumber, int lowerLimit, int upperLimit, string label, bool embedLabel, bool showPercentComplete)
Starts, or shows, Rhino's status bar progress meter.
Parameters:
docSerialNumber (uint)The document runtime serial number.
lowerLimit (int)The lower limit of the progress meter's range.
upperLimit (int)The upper limit of the progress meter's range.
label (string)The short description of the progress (e.g. "Calculating", "Meshing", etc)
embedLabel (bool)If true, then the label will be embedded in the progress meter. If false, then the label will appear to the left of the progress meter.
showPercentComplete (bool)If true, then the percent complete will appear in the progress meter.
Returns: 1 - The progress meter was created successfully. 0 - The progress meter was not created. -1 - The progress meter was not created because some other process has already created it.

UpdateProgressMeter

#Since v5.0
public static int UpdateProgressMeter(int position, bool absolute)
Sets the current position of Rhino's status bar progress meter.
Parameters:
position (int)The new value. This can be stated in absolute terms, or relative compared to the current position.

The interval bounds are specified when you first show the bar.

absolute (bool)If true, then the progress meter is moved to position. If false, then the progress meter is moved position from the current position (relative).
Returns: The previous position if successful.

UpdateProgressMeter

#Since v8.6
public static int UpdateProgressMeter(string label, int position, bool absolute)
Sets the label and current position of Rhino's status bar progress meter.
Parameters:
label (string)The short description of the progress (e.g. "Calculating", "Meshing", etc)
position (int)The new value. This can be stated in absolute terms, or relative compared to the current position. The interval bounds are specified when you first show the bar. Note, if value is RhinoMath.UnsetIntIndex, only the label is updated.
absolute (bool)If true, then the progress meter is moved to position. If false, then the progress meter is moved position from the current position (relative).
Returns: The previous position if successful.

UpdateProgressMeter

#Since v6.12
[CLSCompliant(false)] public static int UpdateProgressMeter(uint docSerialNumber, int position, bool absolute)
Sets the current position of Rhino's status bar progress meter.
Parameters:
docSerialNumber (uint)The document runtime serial number.
position (int)The new value. This can be stated in absolute terms, or relative compared to the current position.

The interval bounds are specified when you first show the bar.

absolute (bool)If true, then the progress meter is moved to position. If false, then the progress meter is moved position from the current position (relative).
Returns: The previous position if successful.

UpdateProgressMeter

#Since v8.6
[CLSCompliant(false)] public static int UpdateProgressMeter(uint docSerialNumber, string label, int position, bool absolute)
Sets the label and current position of Rhino's status bar progress meter.
Parameters:
docSerialNumber (uint)The document runtime serial number.
label (string)The short description of the progress (e.g. "Calculating", "Meshing", etc)
position (int)The new value. This can be stated in absolute terms, or relative compared to the current position. The interval bounds are specified when you first show the bar. Note, if value is RhinoMath.UnsetIntIndex, only the label is updated.
absolute (bool)If true, then the progress meter is moved to position. If false, then the progress meter is moved position from the current position (relative).
Returns: The previous position if successful.