com.esri.arcgis.system
Interface IStepProgressor

All Superinterfaces:
IProgressor, Serializable
All Known Subinterfaces:
ICheckProgressor
All Known Implementing Classes:
GPServerTrackCancel, ICheckProgressorProxy, IStepProgressorProxy

public interface IStepProgressor
extends IProgressor, Serializable

Provides access to members that report progress in stepped increments.

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.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IStatusBar

Method Summary
 int getMaxRange()
          The maximum range of the progression.
 int getMinRange()
          The minimum range of the progression.
 int getPosition()
          The current position of the progression.
 int getStepValue()
          The step increment of the progression.
 int offsetPosition(int offsetValue)
          Offsets the position of the progression.
 void setMaxRange(int maxRange)
          The maximum range of the progression.
 void setMinRange(int minRange)
          The minimum range of the progression.
 void setPosition(int position)
          The current position of the progression.
 void setStepValue(int step)
          The step increment of the progression.
 
Methods inherited from interface com.esri.arcgis.system.IProgressor
getMessage, hide, setMessage, show, step
 

Method Detail

setMinRange

void setMinRange(int minRange)
                 throws IOException,
                        AutomationException
The minimum range of the progression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
minRange - The minRange (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinRange

int getMinRange()
                throws IOException,
                       AutomationException
The minimum range of the progression.

Description

The minimum value of the step progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The minRange
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxRange

void setMaxRange(int maxRange)
                 throws IOException,
                        AutomationException
The maximum range of the progression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
maxRange - The maxRange (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxRange

int getMaxRange()
                throws IOException,
                       AutomationException
The maximum range of the progression.

Description

The maximum value of the step progressor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The maxRange
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStepValue

void setStepValue(int step)
                  throws IOException,
                         AutomationException
The step increment of the progression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
step - The step (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStepValue

int getStepValue()
                 throws IOException,
                        AutomationException
The step increment of the progression.

Description

The increment value taken by the progression with each step.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The step
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPosition

void setPosition(int position)
                 throws IOException,
                        AutomationException
The current position of the progression.

Description

The current position of the progression between the MinRange and MaxRange values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
position - The position (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPosition

int getPosition()
                throws IOException,
                       AutomationException
The current position of the progression.

Description

The current position of the progression between the MinRange and MaxRange values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The position
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

offsetPosition

int offsetPosition(int offsetValue)
                   throws IOException,
                          AutomationException
Offsets the position of the progression.

Description

Offsets the current Position by the specified value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
offsetValue - The offsetValue (in)
Returns:
The prevPos
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.