com.esri.arcgis.trackinganalyst
Interface ITxDocEventHandler2

All Superinterfaces:

ITxDocEventHandler, Serializable

All Known Implementing Classes:

DocEventHandler

public interface ITxDocEventHandler2
extends ITxDocEventHandler, Serializable

Provides access to properties and methods for document event handling.

Description

This interface provides methods and properties to indicate parent document, whether or not the object is valid, and the running environment (e.g., in ArcMap, ArcCatalog and MapControl).

Remarks

This interface is new at ArcGIS 9.3. It supersedes ITxDocEventHandler.

Product Availability

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

Method Summary

int	runningEnvironment() Identifies the client envirionment, e.g., ArcMap, ArcGlobe, Map Control, ...

Methods inherited from interface com.esri.arcgis.trackinganalyst.ITxDocEventHandler

getParentDocument, isApplication, isMapControl, isRunningInArcMap, isRunningInCatalog, isValid

Method Detail

runningEnvironment

int runningEnvironment()
                       throws IOException,
                              AutomationException

Identifies the client envirionment, e.g., ArcMap, ArcGlobe, Map Control, ... with or without dynamic display.

Description

This method identifies the client envirionment, e.g., ArcMap, ArcGlobe, Map Control, ... with or without dynamic display.

Remarks

RunningEnvironment can be used to determine the client application that Tracking Analyst is running inside. This information can be useful when different operations need to be performed depending on the client hosting Tracking Analyst, i.e. a MapControl vs. a GlobeControl. This method supersedes IsMapControl, IsApplication, IsRunningInCatalog, and IsRunningInArcMap in ITxDocEventHandler.

Product Availability

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

Returns:

A com.esri.arcgis.trackinganalyst.enumTrackingEnv constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.