com.esri.arcgis.framework
Interface IProgressDialog2

All Superinterfaces:

Serializable

All Known Implementing Classes:

IProgressDialog2Proxy, ProgressDialog

public interface IProgressDialog2
extends Serializable

Provides access to members that work with a progress dialog.

Description

The IProgressDialog2 interface has methods for hiding and showing the progress dialog box.

Use the IProgressDialogFactory.Create method to create the progress dialog box.

Remarks

The example code below shows how to use progress dialog. You would get m_app from the hook in ICommand::OnCreate().

Product Availability

Available with ArcGIS Desktop.

Method Summary

int	getAnimation() The animation type displayed in the dialog.
String	getDescription() The description displayed in the dialog.
String	getTitle() The caption displayed in the dialog.
void	hideDialog() Hides the progress dialog.
boolean	isCancelEnabled() Indicates if the Cancel button is enabled.
void	setAnimation(int type) The animation type displayed in the dialog.
void	setCancelEnabled(boolean bVal) Indicates if the Cancel button is enabled.
void	setDescription(String status) The description displayed in the dialog.
void	setTitle(String title) The caption displayed in the dialog.
void	showDialog() Shows the progress dialog.

Method Detail

showDialog

void showDialog()
                throws IOException,
                       AutomationException

Shows the progress dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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 Desktop.

Supported Platforms

Windows

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.

Remarks

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 Desktop.

Supported Platforms

Windows

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 Desktop.

Supported Platforms

Windows

Parameters:

bVal - The bVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String status)
                    throws IOException,
                           AutomationException

The description displayed in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

status - The status (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

The description displayed in the dialog.

Remarks

The Description property can be used to provide the user with information about the process that the dialog box is tracking.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The status

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitle

void setTitle(String title)
              throws IOException,
                     AutomationException

The caption displayed in the dialog.

Remarks

The Title property can be used to provide the user with information about the process that the dialog box is tracking.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

String getTitle()
                throws IOException,
                       AutomationException

The caption displayed in the dialog.

Remarks

The Title property can be used to provide the user with information about the process that the dialog box is tracking.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimation

void setAnimation(int type)
                  throws IOException,
                         AutomationException

The animation type displayed in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

type - A com.esri.arcgis.framework.esriProgressAnimationTypes constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAnimation

int getAnimation()
                 throws IOException,
                        AutomationException

The animation type displayed in the dialog.

Remarks

The Animation property specifies the type of animation displayed in the dialog box. The animation in the dialog box can either be the spinning globe animation or the downloading file animation.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.framework.esriProgressAnimationTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.