com.esri.arcgis.system
Interface ITrackCancel2

All Superinterfaces:

ITrackCancel, Serializable

All Known Implementing Classes:

CancelTracker, ITrackCancel2Proxy

public interface ITrackCancel2
extends ITrackCancel, Serializable

Provides access to members that control the Cancel Tracker.

Product Availability

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

Method Summary

int	getTimeout() The time out in ms interval for a lengthy operation.
void	setTimeout(int timeoutMS) The time out in ms interval for a lengthy operation.
void	trackMouseMove(boolean bYesNo) Turns on/off tracking of mouse movements.
void	trackNavigationKeys(boolean bYesNo) Turns on/off tracking of navigation keys.

Methods inherited from interface com.esri.arcgis.system.ITrackCancel

cancel, esri_continue, getCheckTime, getProgressor, isCancelOnClick, isCancelOnKeyPress, isProcessMessages, isTimerFired, reset, setCancelOnClick, setCancelOnKeyPress, setCheckTime, setProcessMessages, setProgressor, startTimer, stopTimer

Method Detail

setTimeout

void setTimeout(int timeoutMS)
                throws IOException,
                       AutomationException

The time out in ms interval for a lengthy operation. The negative value means no timeout.

Product Availability

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

Parameters:

timeoutMS - The timeoutMS (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeout

int getTimeout()
               throws IOException,
                      AutomationException

The time out in ms interval for a lengthy operation. The negative value means no timeout.

Product Availability

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

Returns:

The timeoutMS

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

trackMouseMove

void trackMouseMove(boolean bYesNo)
                    throws IOException,
                           AutomationException

Turns on/off tracking of mouse movements. If bYesNo is true, the cancel is triggered by the mouse move.

Product Availability

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

Parameters:

bYesNo - The bYesNo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

trackNavigationKeys

void trackNavigationKeys(boolean bYesNo)
                         throws IOException,
                                AutomationException

Turns on/off tracking of navigation keys. If bYesNo is true, the cancel is triggered by the navigation key press.

Product Availability

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

Parameters:

bYesNo - The bYesNo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.