com.esri.arcgis.trackinganalyst
Interface ITxDocEventHandler

All Superinterfaces:

Serializable

All Known Subinterfaces:

ITxDocEventHandler2

All Known Implementing Classes:

DocEventHandler

public interface ITxDocEventHandler
extends Serializable

Provides access to properties and methods for document event handling.

Superseded By

ITxDocEventHandler2

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

Hidden function RemoveAllTemporalLayers under this interface always returns E_FAIL.

Product Availability

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

Method Summary

Object	getParentDocument() Parent document responsible for the document event handling.
void	isApplication() Indicates if this object is part of an application.
void	isMapControl() Indicates if this object is attached to a map control.
void	isRunningInArcMap() Indicates if this object is attached to ArcMap.
void	isRunningInCatalog() Indicates if this object is attached to ArcCatalog.
boolean	isValid() Indicates if this object is in a valid state.

Method Detail

getParentDocument

Object getParentDocument()
                         throws IOException,
                                AutomationException

Parent document responsible for the document event handling.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isValid

boolean isValid()
                throws IOException,
                       AutomationException

Indicates if this object is in a valid state.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMapControl

void isMapControl()
                  throws IOException,
                         AutomationException

Indicates if this object is attached to a map control.

Remarks

This method has been superseded by ITxDocEventHandler::RunningEnvironment.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplication

void isApplication()
                   throws IOException,
                          AutomationException

Indicates if this object is part of an application.

Remarks

This method has been superseded by ITxDocEventHandler::RunningEnvironment.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunningInCatalog

void isRunningInCatalog()
                        throws IOException,
                               AutomationException

Indicates if this object is attached to ArcCatalog.

Remarks

This method has been superseded by ITxDocEventHandler::RunningEnvironment.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRunningInArcMap

void isRunningInArcMap()
                       throws IOException,
                              AutomationException

Indicates if this object is attached to ArcMap.

Remarks

This method has been superseded by ITxDocEventHandler::RunningEnvironment.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.