com.esri.arcgis.arccatalog
Interface IGxDocumentEventsDisp

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

IGxDocumentEventsDispAdapter, IGxDocumentEventsDispProxy

public interface IGxDocumentEventsDisp
extends EventListener, 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.

Method Summary

void	activeViewChanged(IGxDocumentEventsDispActiveViewChangedEvent theEvent) Fired when the active view changes.
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	vBAReset(IGxDocumentEventsDispVBAResetEvent theEvent) Fired when VBA is reset.

Method Detail

activeViewChanged

void activeViewChanged(IGxDocumentEventsDispActiveViewChangedEvent theEvent)
                       throws IOException,
                              AutomationException

Fired when the active view changes.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

onContextMenu

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

Parameters:

theEvent - The event

Returns:

The bHandled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

newDocument

void newDocument(IGxDocumentEventsDispNewDocumentEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when a new document is created.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDocument

void openDocument(IGxDocumentEventsDispOpenDocumentEvent theEvent)
                  throws IOException,
                         AutomationException

Fired when a document is opened.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

closeDocument

void closeDocument(IGxDocumentEventsDispCloseDocumentEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when a document is closed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

vBAReset

void vBAReset(IGxDocumentEventsDispVBAResetEvent theEvent)
              throws IOException,
                     AutomationException

Fired when VBA is reset.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.