com.esri.arcgis.geodatabase
Interface ITopologyClassEvents

All Superinterfaces:
EventListener, Serializable
All Known Implementing Classes:
ITopologyClassEventsAdapter, ITopologyClassEventsProxy

public interface ITopologyClassEvents
extends EventListener, Serializable

Provides access to events that occur with a topology class.

Remarks

The ITopologyClassEvents interface provides access to the OnValidate event which is fired each time a dirty area is validated in the topology in which the class is participating. The event returns an IGeometry object corresponding the area that was validated.

ITopologyClassEvents can be listened to by class extensions or custom objects when relying on the ITopologyExtensionEvents::OnValidate event isn't ideal. This is useful when you need to implement a geodatabase-level customization that will not be application specific, i.e. dependent upon ArcMap and the Topology extension.

When To Use

Use ITopologyClassEvents for building ClassExtensions when you don't want to rely on catching the ITopologyExtensionEvents OnValidate event. This is handy when you need to implement a geodatabase-level customization that will not be application specific, i.e. dependent upon ArcMap and the Topology extension.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.


Method Summary
 void onValidate(ITopologyClassEventsOnValidateEvent theEvent)
          This event is fired when the topology containing the class is validated.
 

Method Detail

onValidate

void onValidate(ITopologyClassEventsOnValidateEvent theEvent)
                throws IOException,
                       AutomationException
This event is fired when the topology containing the class is validated.

Remarks

The OnValidate event is fired each time a dirty area is validated in the topology in which the class is participating. Handlers are provided with an IGeometry object corresponding to the dirty areas that were validated. The IGeometry object may represent a single or multi-part polygon or a collection of polygons.

In some cases, using the OnValidate method on feature classes in a Topology may result in a situation where the Topology will always have a Dirty Area such as if the purpose of listening to the OnValidate event is to act on another feature class in the Topology and perform some action on the features in that class.

For example, an extension that listens to the OnValidate event in order to derive features for a feature class by aggregarting the features in the class that is validated. If the dervied features are in a feature class that is in the Topology, the result of the OnValidate event will be a Topology that will always contain a dirty area. The derived feature class should not be in the topology in order for this example to be applicable.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

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