This document is archived and information here might be outdated.  Recommended version.


IStepProgressor Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (System)  

IStepProgressor Interface

Provides access to members that report progress in stepped increments.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

The IStepProgressor interface 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

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.

Inherited Interfaces

Interfaces Description
IProgressor Provides access to members that report progress.

CoClasses that implement IStepProgressor

CoClasses and Classes Description
GPServerTrackCancel (esriGeoprocessing) GP Server Track Cancel Class.
ProgressBar (esriArcMapUI) ProgressBar object.
ProgressDialog (esriArcMapUI) Progress dialog object.

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.

See Also

IProgressor Interface | IStatusBar Interface

.NET Snippets

Show Progress Dialog | Flip Line Direction