com.esri.arcgis.geodatabase
Interface ILocatorUI

All Superinterfaces:
Serializable
All Known Subinterfaces:
ILocatorUI2
All Known Implementing Classes:
ILocatorUI2Proxy, ILocatorUIProxy

public interface ILocatorUI
extends Serializable

Provides access to members that control the locator's user interface.

Superseded By

ILocatorUI2

Remarks

The ILocatorUI interface is available, but the LocatorUI object is not using the ArcGIS Engine license.

When To Use

Use the ILocatorUI interface to display the basic user interfaces for a locator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 ILocator createLocator(int parentWindow, ILocatorStyle locatorStyle, ILocatorWorkspace locWks, String connectionName)
          Opens the user interface to create a new locator.
 boolean locatorProperties(int parentWindow, ILocator locator, String title)
          Opens the user interface to view or modify the properties of a locator.
 IName matchTable(int parentWindow, ITable tableOfLocations, ILocator locator, String[] pathForGxBrowser)
          Opens the user interface to locate a table.
 

Method Detail

createLocator

ILocator createLocator(int parentWindow,
                       ILocatorStyle locatorStyle,
                       ILocatorWorkspace locWks,
                       String connectionName)
                       throws IOException,
                              AutomationException
Opens the user interface to create a new locator.

Remarks

The CreateLocator method displays the user interface for creating a new locator. This method creates a new locator in the locator workspace specified, and returns a reference to the locator.

The parentWindow parameter is a long integer value containing the handle to the parent window for the user interface. The user interface appears modally on top of this window.

The locatorStyle parameter is a reference to the locator style on which the new locator will be based.

The locWks is a reference to the locator workspace that will contain the new locator. In general, this will be the same locator workspace from which the locator style was retrieved. It is important to note that locators based on locator styles from a local locator workspace cannot be stored in an ArcSDE locator workspace. Likewise, locators based on locator styles from an ArcSDE locator workspace cannot be stored in a local locator workspace.

The connectionName parameter is the name of the GxObject from which the user can start browsing for reference data for the locator. You can obtain a value for this parameter from the IGxObject::FullName property of the GxObject.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
parentWindow - The parentWindow (A COM typedef) (in)
locatorStyle - A reference to a com.esri.arcgis.geodatabase.ILocatorStyle (in)
locWks - A reference to a com.esri.arcgis.geodatabase.ILocatorWorkspace (in)
connectionName - The connectionName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.ILocator
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
com.esri.arcgis.locationui.IGxLocatorFilter, com.esri.arcgis.locationui.GxNewLocator, ILocatorUI.createLocator(int, com.esri.arcgis.geodatabase.ILocatorStyle, com.esri.arcgis.geodatabase.ILocatorWorkspace, String), com.esri.arcgis.locationui.IGxNewLocator

locatorProperties

boolean locatorProperties(int parentWindow,
                          ILocator locator,
                          String title)
                          throws IOException,
                                 AutomationException
Opens the user interface to view or modify the properties of a locator.

Remarks

The LocatorProperties method displays the user interface for modifying a locator's properties. If the user commits the changes to the locator workspace using the user interface, this method returns a value of True. Otherwise, it returns a value of False.

The parentWindow parameter is a handle to the parent window for the user interface. The user interface for the locator appears modally on top of this window.

The Locator parameter is a reference to the locator whose properties you want to modify using the user interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
parentWindow - The parentWindow (A COM typedef) (in)
locator - A reference to a com.esri.arcgis.geodatabase.ILocator (in)
title - The title (in)
Returns:
The ok
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
com.esri.arcgis.locationui.IAddressUI, ILocatorUI.locatorProperties(int, com.esri.arcgis.geodatabase.ILocator, String)

matchTable

IName matchTable(int parentWindow,
                 ITable tableOfLocations,
                 ILocator locator,
                 String[] pathForGxBrowser)
                 throws IOException,
                        AutomationException
Opens the user interface to locate a table.

Remarks

The MatchTable method displays the user interface for matching a table of locations. This method returns a reference to a Name object that represents the matched dataset.

The parentWindow parameter is a handle to the parent window for the user interface. The user interface for matching the table appears modally on top of this window.

The tableOfLocations parameter is a reference to the table that contains the locations to be matched. The Locator parameter is a reference to the locator that you want to use to match the table.

The pathForGxBrowser parameter is the name of the GxObject from which the user can start browsing for a location for the matched dataset. You can obtain a value for this parameter from the IGxObject::FullName property of the GxObject.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
parentWindow - The parentWindow (A COM typedef) (in)
tableOfLocations - A reference to a com.esri.arcgis.geodatabase.ITable (in)
locator - A reference to a com.esri.arcgis.geodatabase.ILocator (in)
pathForGxBrowser - The pathForGxBrowser (in/out: use single element array)
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.
See Also:
com.esri.arcgis.locationui.IAddressUI, ILocatorUI.matchTable(int, com.esri.arcgis.geodatabase.ITable, com.esri.arcgis.geodatabase.ILocator, String[])