com.esri.arcgis.arccatalog
Interface IGxDocumentEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

IGxDocumentEventsAdapter, IGxDocumentEventsProxy

public interface IGxDocumentEvents
extends EventListener, Serializable

Provides access to events fired by ArcCatalog.

Remarks

In Visual Basic and VBA use the IGxDocumentEventsDisp interface instead of IGxDocumentEvents.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	activeViewChanged(IGxDocumentEventsActiveViewChangedEvent theEvent) Fired when the active view changes.
void	closeDocument(IGxDocumentEventsCloseDocumentEvent theEvent) Fired when a document is closed.
void	newDocument(IGxDocumentEventsNewDocumentEvent theEvent) Fired when a new document is created.
void	onContextMenu(IGxDocumentEventsOnContextMenuEvent theEvent) Fired when a context menu should be displayed at the given xy location.
void	openDocument(IGxDocumentEventsOpenDocumentEvent theEvent) Fired when a document is opened.

Method Detail

activeViewChanged

void activeViewChanged(IGxDocumentEventsActiveViewChangedEvent 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

void onContextMenu(IGxDocumentEventsOnContextMenuEvent 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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

newDocument

void newDocument(IGxDocumentEventsNewDocumentEvent 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(IGxDocumentEventsOpenDocumentEvent 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(IGxDocumentEventsCloseDocumentEvent 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.