IStepProgressor Interface

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
Method Hide Hides the progressor.
Read/write property MaxRange The maximum range of the progression.
Read/write property Message The message displayed by the progressor.
Read/write property MinRange The minimum range of the progression.
Method OffsetPosition Offsets the position of the progression.
Read/write property Position The current position of the progression.
Method Show Shows the progressor.
Method Step Animates or steps the progressor.
Read/write property 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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.