com.esri.arcgis.arccatalog
Class IGxDocumentEventsDispProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.arccatalog.IGxDocumentEventsDispProxy

All Implemented Interfaces:

IGxDocumentEventsDisp, Externalizable, Serializable, EventListener

public class IGxDocumentEventsDispProxy
extends com.esri.arcgis.interop.Dispatch
implements IGxDocumentEventsDisp, Serializable

Provides access to events fired by ArcCatalog.

Remarks

When you are working in VBA, the IGxDocumentEventsDisp interface is automatically exposed for you. There is a GxDocument object defined in the ThisDocument class module. Select that object in the Object Box on the ThisDocument code window and then you can choose any of its events by clicking in the Procedure/Method Box on the ThisDocument code window. This stubs out the event procedures and you can write your code here.

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

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

Method Summary

void	activeViewChanged(IGxDocumentEventsDispActiveViewChangedEvent theEvent) Fired when the active view changes.
void	addListener(String iidStr, Object theListener, Object theSource)
void	closeDocument(IGxDocumentEventsDispCloseDocumentEvent theEvent) Fired when a document is closed.
void	newDocument(IGxDocumentEventsDispNewDocumentEvent theEvent) Fired when a new document is created.
boolean	onContextMenu(IGxDocumentEventsDispOnContextMenuEvent theEvent) Fired when a context menu should be displayed at the given xy location.
void	openDocument(IGxDocumentEventsDispOpenDocumentEvent theEvent) Fired when a document is opened.
void	removeListener(String iidStr, Object theListener)
void	vBAReset(IGxDocumentEventsDispVBAResetEvent theEvent) Fired when VBA is reset.

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

IGxDocumentEventsDispProxy

public IGxDocumentEventsDispProxy()

IGxDocumentEventsDispProxy

public IGxDocumentEventsDispProxy(Object obj)
                           throws IOException

Throws:

IOException

IGxDocumentEventsDispProxy

protected IGxDocumentEventsDispProxy(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

activeViewChanged

public void activeViewChanged(IGxDocumentEventsDispActiveViewChangedEvent theEvent)
                       throws IOException,
                              AutomationException

Fired when the active view changes.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

activeViewChanged in interface IGxDocumentEventsDisp

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onContextMenu

public boolean onContextMenu(IGxDocumentEventsDispOnContextMenuEvent theEvent)
                      throws IOException,
                             AutomationException

Fired when a context menu should be displayed at the given xy location. Return true if handled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

onContextMenu in interface IGxDocumentEventsDisp

Parameters:

theEvent - The event

Returns:

The bHandled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

newDocument

public void newDocument(IGxDocumentEventsDispNewDocumentEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when a new document is created.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

newDocument in interface IGxDocumentEventsDisp

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDocument

public void openDocument(IGxDocumentEventsDispOpenDocumentEvent theEvent)
                  throws IOException,
                         AutomationException

Fired when a document is opened.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

openDocument in interface IGxDocumentEventsDisp

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

closeDocument

public void closeDocument(IGxDocumentEventsDispCloseDocumentEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when a document is closed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

closeDocument in interface IGxDocumentEventsDisp

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

vBAReset

public void vBAReset(IGxDocumentEventsDispVBAResetEvent theEvent)
              throws IOException,
                     AutomationException

Fired when VBA is reset.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

vBAReset in interface IGxDocumentEventsDisp

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.