com.esri.arcgis.framework
Class IProgressDialog2Proxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.framework.IProgressDialog2Proxy

All Implemented Interfaces:

IProgressDialog2, Externalizable, Serializable

public class IProgressDialog2Proxy
extends com.esri.arcgis.interop.Dispatch
implements IProgressDialog2, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	IProgressDialog2Proxy()
	IProgressDialog2Proxy(Object obj)
protected	IProgressDialog2Proxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

IProgressDialog2Proxy

public IProgressDialog2Proxy()

IProgressDialog2Proxy

public IProgressDialog2Proxy(Object obj)
                      throws IOException

Throws:

IOException

IProgressDialog2Proxy

protected IProgressDialog2Proxy(Object obj,
                                String iid)
                         throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

showDialog

public void showDialog()
                throws IOException,
                       AutomationException

Shows the progress dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

showDialog in interface IProgressDialog2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hideDialog

public void hideDialog()
                throws IOException,
                       AutomationException

Hides the progress dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

hideDialog in interface IProgressDialog2

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelEnabled

public 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

Specified by:

isCancelEnabled in interface IProgressDialog2

Returns:

The bVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelEnabled

public void setCancelEnabled(boolean bVal)
                      throws IOException,
                             AutomationException

Indicates if the Cancel button is enabled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCancelEnabled in interface IProgressDialog2

Parameters:

bVal - The bVal (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(String status)
                    throws IOException,
                           AutomationException

The description displayed in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setDescription in interface IProgressDialog2

Parameters:

status - The status (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public 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

Specified by:

getDescription in interface IProgressDialog2

Returns:

The status

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTitle

public 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

Specified by:

setTitle in interface IProgressDialog2

Parameters:

title - The title (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTitle

public 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

Specified by:

getTitle in interface IProgressDialog2

Returns:

The title

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAnimation

public void setAnimation(int type)
                  throws IOException,
                         AutomationException

The animation type displayed in the dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setAnimation in interface IProgressDialog2

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

public 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

Specified by:

getAnimation in interface IProgressDialog2

Returns:

A com.esri.arcgis.framework.esriProgressAnimationTypes constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.