com.esri.arcgis.controls
Interface IEngineNAWindowEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

IEngineNAWindowEventsAdapter, IEngineNAWindowEventsProxy

public interface IEngineNAWindowEvents
extends EventListener, Serializable

Provides access to events triggered by the network analysis window.

Description

The IEngineNAWindowEvents interface is an outgoing interface on the IEngineNetworkAnalystEnvironment::NAWindow object that is used to notify listeners when the selected analysis layer, selected category, analysis results, or context has been updated.

These events are not fired if IEngineNAWindow::DelayEvents has been set to true.

Product Availability

Available with ArcGIS Engine.

Method Summary

void	onActiveAnalysisChanged(IEngineNAWindowEventsOnActiveAnalysisChangedEvent theEvent) Called when the active analysis changes.
void	onActiveCategoryChanged(IEngineNAWindowEventsOnActiveCategoryChangedEvent theEvent) Called when the active category changes.
void	onActiveNAContextUpdated(IEngineNAWindowEventsOnActiveNAContextUpdatedEvent theEvent) Called when the active context has been updated.
void	onActiveNAResultUpdated(IEngineNAWindowEventsOnActiveNAResultUpdatedEvent theEvent) Called when the active result has been updated.

Method Detail

onActiveCategoryChanged

void onActiveCategoryChanged(IEngineNAWindowEventsOnActiveCategoryChangedEvent theEvent)
                             throws IOException,
                                    AutomationException

Called when the active category changes.

Description

The OnActiveCategoryChanged event is fired when a different category (e.g. Stops, Barriers, Routes, etc) is chosen within the IEngineNetworkAnalystEnvironment::NAWindow interactively by the end user.

The event is not fired when the IEngineNAWindow::ActiveCategory property is set programatically or if IEngineNAWindow::DelayEvents has been set to true.

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.

onActiveAnalysisChanged

void onActiveAnalysisChanged(IEngineNAWindowEventsOnActiveAnalysisChangedEvent theEvent)
                             throws IOException,
                                    AutomationException

Called when the active analysis changes.

Description

The OnActiveAnalysisChanged event is fired when a NALayer is chosen from the dropdown at the top of the IEngineNetworkAnalystEnvironment::NAWindow or the IEngineNAWindow::ActiveAnalysis is programatically set.

The event is not fired when the IEngineNAWindow::ActiveAnalysis property is set programatically to Nothing or if IEngineNAWindow::DelayEvents has been set to true.

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.

onActiveNAContextUpdated

void onActiveNAContextUpdated(IEngineNAWindowEventsOnActiveNAContextUpdatedEvent theEvent)
                              throws IOException,
                                     AutomationException

Called when the active context has been updated.

Description

The OnActiveNAContextUpdated event is fired when the NAContext is modified. This includes edits to a NALocationObject in INAContext::NAClasses.

This event is not fired if IEngineNAWindow::DelayEvents has been set to true.

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.

onActiveNAResultUpdated

void onActiveNAResultUpdated(IEngineNAWindowEventsOnActiveNAResultUpdatedEvent theEvent)
                             throws IOException,
                                    AutomationException

Called when the active result has been updated.

Description

The OnActiveNAResultUpdated event is fired when a solve is performed and the analysis results have changed.

This event is not fired if IEngineNAWindow::DelayEvents has been set to true.

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.