com.esri.arcgis.catalogUI
Interface IFindDialog

All Superinterfaces:

Serializable

All Known Implementing Classes:

FindDialog

public interface IFindDialog
extends Serializable

Provides access to members that control the operation of the Search dialog box.

Remarks

You can only use this interface in ArcCatalog application.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	doSearch(IQuery pQuery) Starts executing the search defined by the query.
int	getNumSearchEngines() Number of available search engines.
ISearchEngine	getSearchEngine(int index) The nth search engine.
void	initialize(IQuery pQuery) Initializes the dialog box based on a query's parameters and then opens it.
boolean	isVisible() Indicates if the dialog box is visible.
void	show(boolean bShow) Initializes the dialog box and opens it if indicated.
void	stopSearch() Cancels an ongoing search.

Method Detail

show

void show(boolean bShow)
          throws IOException,
                 AutomationException

Initializes the dialog box and opens it if indicated.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

bShow - The bShow (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the dialog box is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pVisible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doSearch

void doSearch(IQuery pQuery)
              throws IOException,
                     AutomationException

Starts executing the search defined by the query.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pQuery - A reference to a com.esri.arcgis.catalog.IQuery (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopSearch

void stopSearch()
                throws IOException,
                       AutomationException

Cancels an ongoing search.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

void initialize(IQuery pQuery)
                throws IOException,
                       AutomationException

Initializes the dialog box based on a query's parameters and then opens it.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pQuery - A reference to a com.esri.arcgis.catalog.IQuery (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumSearchEngines

int getNumSearchEngines()
                        throws IOException,
                               AutomationException

Number of available search engines.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The num

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchEngine

ISearchEngine getSearchEngine(int index)
                              throws IOException,
                                     AutomationException

The nth search engine.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.catalogUI.ISearchEngine

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.