Provides access to members that report progress in stepped increments.
Description
The IStepProgressorinterface has properties for setting the properties of the step progress bar, such as the message, the minimum and maximum values, and the step size. The step progressor bar is the blue moving line that displays the percentage of completeness.
Use IStatusBar::ProgressorBar to access the step progress bar.
Members
| Name | Description | |
|---|---|---|
 |
Hide | Hides the progressor. |
 |
MaxRange | The maximum range of the progression. |
|
Message | The message displayed by the progressor. |
|
MinRange | The minimum range of the progression. |
|
OffsetPosition | Offsets the position of the progression. |
|
Position | The current position of the progression. |
|
Show | Shows the progressor. |
|
Step | Animates or steps the progressor. |
|
StepValue | The step increment of the progression. |
IStepProgressor.MaxRange Property
The maximum range of the progression.
Public Property MaxRange As Integer
public int MaxRange {get; set;}
Description
The maximum value of the step progressor.
IStepProgressor.MinRange Property
The minimum range of the progression.
Public Property MinRange As Integer
public int MinRange {get; set;}
Description
The minimum value of the step progressor.
IStepProgressor.OffsetPosition Method
Offsets the position of the progression.
Public Function OffsetPosition ( _
ByVal offsetValue As Integer _
) As Integer
public int OffsetPosition (
int offsetValue
);
Description
Offsets the current Position by the specified value.
IStepProgressor.Position Property
The current position of the progression.
Public Property Position As Integer
public int Position {get; set;}
Description
The current position of the progression between the MinRange and MaxRange values.
IStepProgressor.StepValue Property
The step increment of the progression.
Public Property StepValue As Integer
public int StepValue {get; set;}
Description
The increment value taken by the progression with each step.
Inherited Interfaces
| Interfaces | Description |
|---|---|
| IProgressor | Provides access to members that report progress. |
Classes that implement IStepProgressor
| Classes | Description |
|---|
Remarks
The IStatusBar::ShowProgressBar method provides shortcuts to the properties of the step progress bar. This method allows you to set the message, minimum and maximum values, and the step size of the step progress bar and also display the step progress bar. Therefore, it is unnecessary to use IStepProgressor to do this.