GH_ProgressBar

UserControlContainerControlScrollableControlControlComponentMarshalByRefObject
[DesignerGenerated] public class GH_ProgressBar : UserControl
General utility progress bar.

Properties

CurrentStep

#
public int CurrentStep { get; }
Gets the current step of the process.

DrawPercentage

#
public bool DrawPercentage { get; set; }
Gets or sets a value that controls whether or not the percentage is included in progress bar rendering.

DrawSteps

#
public bool DrawSteps { get; set; }
Gets or sets a value that controls whether or not the steps are included in progress bar rendering.

Message

#
public string Message { get; set; }
Gets or sets the text displayed on the progress bar.

Progress

#
public double Progress { get; set; }
Gets or sets the progress value (0.0 ~ 1.0)

Methods

Dispose

#
protected override void Dispose(bool disposing)
Parameters:
disposing (bool)
Overrides: ContainerControl.Dispose

OnPaint

#
protected override void OnPaint(PaintEventArgs e)
Parameters:
e (PaintEventArgs)
Overrides: Control.OnPaint

OnPaintBackground

#
protected override void OnPaintBackground(PaintEventArgs e)
Parameters:
e (PaintEventArgs)
Overrides: ScrollableControl.OnPaintBackground

SetMaxSteps

#
public void SetMaxSteps(int S)
Sets the maximum number of steps that will be handled during the upcoming progress.
Parameters:
S (int)Number of steps.

SetStep

#
public void SetStep(int N, string sText)
Set the current step and message.
Parameters:
N (int)Current step
sText (string)Message for this step.

SetStep

#
public void SetStep(int N)
Set the current step.
Parameters:
N (int)Current step.