com.esri.arcgis.trackinganalyst
Interface ITxDocumentEvents

All Superinterfaces:
EventListener, Serializable
All Known Implementing Classes:
ITxDocumentEventsAdapter, ITxDocumentEventsProxy

public interface ITxDocumentEvents
extends EventListener, Serializable

Provides access to events that occur in documents with tracking analyst objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.


Method Summary
 void activeViewChanged(ITxDocumentEventsActiveViewChangedEvent theEvent)
          Fired when the active view changes.
 boolean beforeCloseDocument(ITxDocumentEventsBeforeCloseDocumentEvent theEvent)
          Fired before a document is closed.
 void closeDocument(ITxDocumentEventsCloseDocumentEvent theEvent)
          Fired when a document is closed.
 void mapsChanged(ITxDocumentEventsMapsChangedEvent theEvent)
          Fired when a change is made to the map collection.
 void newDocument(ITxDocumentEventsNewDocumentEvent theEvent)
          Fired when a new document is created.
 void onContextMenu(ITxDocumentEventsOnContextMenuEvent theEvent)
          Indicates if a context menu should be displayed at the given xy location.
 void openDocument(ITxDocumentEventsOpenDocumentEvent theEvent)
          Fired when a document is opened.
 

Method Detail

activeViewChanged

void activeViewChanged(ITxDocumentEventsActiveViewChangedEvent theEvent)
                       throws IOException,
                              AutomationException
Fired when the active view changes.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

mapsChanged

void mapsChanged(ITxDocumentEventsMapsChangedEvent theEvent)
                 throws IOException,
                        AutomationException
Fired when a change is made to the map collection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

onContextMenu

void onContextMenu(ITxDocumentEventsOnContextMenuEvent 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 Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

newDocument

void newDocument(ITxDocumentEventsNewDocumentEvent theEvent)
                 throws IOException,
                        AutomationException
Fired when a new document is created.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openDocument

void openDocument(ITxDocumentEventsOpenDocumentEvent theEvent)
                  throws IOException,
                         AutomationException
Fired when a document is opened.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

beforeCloseDocument

boolean beforeCloseDocument(ITxDocumentEventsBeforeCloseDocumentEvent theEvent)
                            throws IOException,
                                   AutomationException
Fired before a document is closed. Return True to abort the close process.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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(ITxDocumentEventsCloseDocumentEvent theEvent)
                   throws IOException,
                          AutomationException
Fired when a document is closed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

Parameters:
theEvent - The event
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.