com.esri.arcgis.addinframework
Interface IRequestProgress

All Superinterfaces:

Serializable

All Known Implementing Classes:

IRequestProgressProxy

public interface IRequestProgress
extends Serializable

Method Summary

void	showProgress(String caption, int timeEstimate, boolean enableCancelButton) Shows the progress dialog while this request is executing.
void	updateMessage(String message) Updates the message shown in the progress dialog.
void	updateStatus(String status) Updates the status message shown in the progress dialog.
void	updateTime(int timeInSeconds) Updates the estimated remaining time displayed on the progress dialog.

Method Detail

showProgress

void showProgress(String caption,
                  int timeEstimate,
                  boolean enableCancelButton)
                  throws IOException,
                         AutomationException

Shows the progress dialog while this request is executing.

Parameters:

caption - The caption (in)

timeEstimate - The timeEstimate (in)

enableCancelButton - The enableCancelButton (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateMessage

void updateMessage(String message)
                   throws IOException,
                          AutomationException

Updates the message shown in the progress dialog.

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateStatus

void updateStatus(String status)
                  throws IOException,
                         AutomationException

Updates the status message shown in the progress dialog.

Parameters:

status - The status (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateTime

void updateTime(int timeInSeconds)
                throws IOException,
                       AutomationException

Updates the estimated remaining time displayed on the progress dialog.

Parameters:

timeInSeconds - The timeInSeconds (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.