com.esri.arcgis.systemUI
Interface IProgressDialog

All Superinterfaces:
Serializable
All Known Implementing Classes:
IProgressDialogProxy

public interface IProgressDialog
extends Serializable

Provides access to members that work with a progress dialog.

Superseded By

IProgressDialog2

Description

Instead of reporting the progress of an operation in the status bar of an ArcGIS application window, you can display a progress dialog box instead. The progress dialog box displays an animation and a step progress bar.

The IProgressDialogFactory::Create method to create and display a progress dialog box. Pass a CancelTracker object to the Create method to allow the user to cancel the process.

The IProgressDialog interface is the original interface for the progress dialog box. However, you should use the more recent IProgressDialog2 interface instead.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void hideDialog()
          Hides the progress dialog.
 boolean isCancelEnabled()
          Indicates if the cancel button is enabled.
 void setCancelEnabled(boolean bVal)
          Indicates if the cancel button is enabled.
 void showDialog()
          Shows the progress dialog.
 

Method Detail

showDialog

void showDialog()
                throws IOException,
                       AutomationException
Shows the progress dialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

hideDialog

void hideDialog()
                throws IOException,
                       AutomationException
Hides the progress dialog.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isCancelEnabled

boolean isCancelEnabled()
                        throws IOException,
                               AutomationException
Indicates if the cancel button is enabled.

Description

The CancelEnabled property specifies if the Cancel button is enabled. If CancelEnabled is set to True, you can use the Continue method on the CancelTracker object to determine if the user hit Cancel and the operations should be stopped.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCancelEnabled

void setCancelEnabled(boolean bVal)
                      throws IOException,
                             AutomationException
Indicates if the cancel button is enabled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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