com.esri.arcgis.catalogUI
Interface ISearchEngineProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

CatalogSearchEngine, FileSystemXmlSearchEngine, ISearchEnginePropertiesProxy, MetadataServiceEngine

public interface ISearchEngineProperties
extends Serializable

Provides access to members that modify the search engine's property set.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	edit(int parentHWnd) Opens a dialog box that lets a user set the search engine's properties.
String	getLocationString() Starting location of a search.
void	load(IPropertySet pPropertySet) Loads the search engine properties from the given property set.
void	save(IPropertySet pPropertySet) Saves the search engine properties to the given property set.
void	setLocationString(String pLocation) Starting location of a search.

Method Detail

edit

void edit(int parentHWnd)
          throws IOException,
                 AutomationException

Opens a dialog box that lets a user set the search engine's properties.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

parentHWnd - The parentHWnd (A COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

void load(IPropertySet pPropertySet)
          throws IOException,
                 AutomationException

Loads the search engine properties from the given property set.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

void save(IPropertySet pPropertySet)
          throws IOException,
                 AutomationException

Saves the search engine properties to the given property set.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocationString

String getLocationString()
                         throws IOException,
                                AutomationException

Starting location of a search.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pLocation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocationString

void setLocationString(String pLocation)
                       throws IOException,
                              AutomationException

Starting location of a search.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pLocation - The pLocation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.