com.esri.arcgis.catalogUI
Interface ISearchEngineEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

FindDialog, ISearchEngineEventsAdapter

public interface ISearchEngineEvents
extends EventListener, Serializable

Provides access to events that are fired by an ongoing search.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	objectFound(ISearchEngineEventsObjectFoundEvent theEvent) Fired when an object is found that satisfies the search criteria.
void	searchCanceled(ISearchEngineEventsSearchCanceledEvent theEvent) Fired when the search is explicitly canceled.
void	searchFailed(ISearchEngineEventsSearchFailedEvent theEvent) Fired when the search terminates prematurely.
void	searchFinished(ISearchEngineEventsSearchFinishedEvent theEvent) Fired when the search is complete.
void	searchLocationChanged(ISearchEngineEventsSearchLocationChangedEvent theEvent) Fired when the search begins looking inside a new folder or other container.

Method Detail

objectFound

void objectFound(ISearchEngineEventsObjectFoundEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when an object is found that satisfies the search criteria.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchFinished

void searchFinished(ISearchEngineEventsSearchFinishedEvent theEvent)
                    throws IOException,
                           AutomationException

Fired when the search is complete.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchFailed

void searchFailed(ISearchEngineEventsSearchFailedEvent theEvent)
                  throws IOException,
                         AutomationException

Fired when the search terminates prematurely.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchCanceled

void searchCanceled(ISearchEngineEventsSearchCanceledEvent theEvent)
                    throws IOException,
                           AutomationException

Fired when the search is explicitly canceled.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchLocationChanged

void searchLocationChanged(ISearchEngineEventsSearchLocationChangedEvent theEvent)
                           throws IOException,
                                  AutomationException

Fired when the search begins looking inside a new folder or other container.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.