com.esri.arcgis.controls
Interface ITOCBuddyEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

ITOCBuddyEventsAdapter, ITOCBuddyEventsProxy

public interface ITOCBuddyEvents
extends EventListener, Serializable

Provides access to events that notify the TOC of a change.

Description

The ITOCBuddyEvents interface can be implemented as an outbound events interface by the Buddy of the TOCControl (e.g. the MapControl). You would only implement this interface if you are creating a control or object that can be a Buddy of the TOCControl. The TOCControl listens to this interface (as well as IActiveViewEvents) in order to refresh maps, layers and symbology, and to re-sync events.

For example, when a new map document is loaded into the MapControl the IActiveView object contained within the MapControl gets replaced. If the MapControl is 'buddied' to a TOCControl, the MapControl fires the ITOCBuddyEvents::ActiveViewReplaced event to the TOCControl. The TOCControl stops listening to events on the 'old' IActiveView object and starts listening to events on the 'new' IActiveView object contained within the MapControl. This ensures the TOCControl automatically reflects the maps, layers and symbology of the Buddy.

Product Availability

Available with ArcGIS Engine.

Method Summary

void	activeViewChanged(ITOCBuddyEventsActiveViewChangedEvent theEvent) Notifies the TOC that the active view has changed and an Update is required.
void	activeViewReplaced(ITOCBuddyEventsActiveViewReplacedEvent theEvent) Notifies the TOC that the active view has been replaced.

Method Detail

activeViewReplaced

void activeViewReplaced(ITOCBuddyEventsActiveViewReplacedEvent theEvent)
                        throws IOException,
                               AutomationException

Notifies the TOC that the active view has been replaced.

Description

The ActiveViewReplaced event is triggered when the ActiveView of the ITOCControl::Buddy is replaced.

For example, when a new map document is loaded into the MapControl the IActiveView object contained within the MapControl gets replaced. If the MapControl is 'buddied' to a TOCControl, the MapControl fires the ITOCBuddyEvents::ActiveViewReplaced event to the TOCControl. The TOCControl stops listening to events on the 'old' IActiveView object and starts listening to events on the 'new' IActiveView object contained within the MapControl. This ensures the TOCControl automatically reflects the maps, layers and symbology of the Buddy.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

activeViewChanged

void activeViewChanged(ITOCBuddyEventsActiveViewChangedEvent theEvent)
                       throws IOException,
                              AutomationException

Notifies the TOC that the active view has changed and an Update is required.

Description

The ActiveViewChanged event is triggered whenever there is a scale change in the ActiveView of the ITOCControl::Buddy. This event is fired when the TOCControl has a 'buddy' GlobeControl and the IGlobeDisplayEvents::InteractionStopped event is fired.

Product Availability

Available with ArcGIS Engine.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.