com.esri.arcgis.framework
Interface IProgressDialogFactory

All Superinterfaces:

Serializable

All Known Implementing Classes:

ProgressDialogFactory

public interface IProgressDialogFactory
extends Serializable

Provides access to a method that creates a progress dialog.

Description

Instead of reporting the progress of an operation in the status bar, you can display a progress dialog box instead. The progress dialog box displays an animation and a step progress bar. The IProgressDialogFactory interface is used to create and display a new progress dialog box.

Remarks

The following example shows how to use progress dialog.

You would get m_app from the hook in ICommand::OnCreate().

Product Availability

Available with ArcGIS Desktop.

See Also:

IStepProgressor

Method Summary

IStepProgressor

create(ITrackCancel trackCancel, int hWnd) Creates a progress dialog.

Method Detail

create

IStepProgressor create(ITrackCancel trackCancel,
                       int hWnd)
                       throws IOException,
                              AutomationException

Creates a progress dialog.

Remarks

The Create method creates and displays a progress dialog box. You can pass a CancelTracker object into this method to allow the user to cancel the process.

This method returns a ProgressDialog object so that you can set the properties of the dialog and the progressor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.system.IStepProgressor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.