com.esri.arcgis.system
Interface ICheckProgressor

All Superinterfaces:
IProgressor, IStepProgressor, Serializable
All Known Implementing Classes:
ICheckProgressorProxy

public interface ICheckProgressor
extends IStepProgressor, Serializable

Provides access to members that report progress in stepped increments with checkmarks.

Remarks

Used the ICheckProgressor interface to report progress on the step progress bar in stepped increments with checkmarks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void addCheck(int index, String msg)
          Adds a field that a checkmark can be added to.
 void hideCheck(int index)
          Hides the checkmark.
 void showCheck(int index)
          Displays the checkmark.
 
Methods inherited from interface com.esri.arcgis.system.IStepProgressor
getMaxRange, getMinRange, getPosition, getStepValue, offsetPosition, setMaxRange, setMinRange, setPosition, setStepValue
 
Methods inherited from interface com.esri.arcgis.system.IProgressor
getMessage, hide, setMessage, show, step
 

Method Detail

addCheck

void addCheck(int index,
              String msg)
              throws IOException,
                     AutomationException
Adds a field that a checkmark can be added to.

Description

Adds a checkmark at the specified index with the specified message.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

showCheck

void showCheck(int index)
               throws IOException,
                      AutomationException
Displays the checkmark.

Description

Shows the checkmark at the specified index. Use the HideCheck method to hide the checkmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

hideCheck

void hideCheck(int index)
               throws IOException,
                      AutomationException
Hides the checkmark.

Description

Hides the checkmark at the specified index. Use the ShowCheck method to show the checkmark.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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