com.esri.arcgis.arcmapui
Interface IDocumentEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

ColorCorrectionDockWin, DataGraphWindow, FindWindowUI, GpsExtension, HistoryViewerWindow, IDocumentEventsAdapter, IDocumentEventsProxy, ImageInsetWindow, MapInsetWindow, MetadataViewWindow, OverviewWindow, PixelInspectionDockWin, RasterToolsDockWin, ReportSelection, TableProperties, TOCCatalogView, TOCSelectionView

public interface IDocumentEvents
extends EventListener, Serializable

Provides access to events that occur in ArcMap.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	activeViewChanged(IDocumentEventsActiveViewChangedEvent theEvent) Fired when the active view changes.
boolean	beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent) Fired before a document is closed.
void	closeDocument(IDocumentEventsCloseDocumentEvent theEvent) Fired when a document is closed.
void	mapsChanged(IDocumentEventsMapsChangedEvent theEvent) Fired when a change is made to the map collection.
void	newDocument(IDocumentEventsNewDocumentEvent theEvent) Fired when a new document is created.
void	onContextMenu(IDocumentEventsOnContextMenuEvent theEvent) Indicates if a context menu should be displayed at the given xy location.
void	openDocument(IDocumentEventsOpenDocumentEvent theEvent) Fired when a document is opened.

Method Detail

activeViewChanged

void activeViewChanged(IDocumentEventsActiveViewChangedEvent 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.

mapsChanged

void mapsChanged(IDocumentEventsMapsChangedEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when a change is made to the map collection.

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(IDocumentEventsOnContextMenuEvent theEvent)
                   throws IOException,
                          AutomationException

Indicates if 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(IDocumentEventsNewDocumentEvent 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(IDocumentEventsOpenDocumentEvent 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.

beforeCloseDocument

boolean beforeCloseDocument(IDocumentEventsBeforeCloseDocumentEvent theEvent)
                            throws IOException,
                                   AutomationException

Fired before a document is closed. Return True to abort the close process.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Returns:

The abortClose

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

closeDocument

void closeDocument(IDocumentEventsCloseDocumentEvent 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.