Provides access to members that control the locator's user interface.
When To Use
Use the ILocatorUI interface to display the basic user interfaces for a locator.
Members
| Name | Description | |
|---|---|---|
 |
CreateLocator | Opens the user interface to create a new locator. |
|
LocatorProperties | Opens the user interface to view or modify the properties of a locator. |
|
MatchTable | Opens the user interface to locate a table. |
ILocatorUI.CreateLocator Method
Opens the user interface to create a new locator.
Public Function CreateLocator ( _
ByVal parentWindow As Integer, _
ByVal locatorStyle As ILocatorStyle, _
ByVal locWks As ILocatorWorkspace, _
ByVal connectionName As String _
) As ILocator
public ILocator CreateLocator (
int parentWindow,
ILocatorStyle locatorStyle,
ILocatorWorkspace locWks,
string connectionName
);
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.
ILocatorUI.LocatorProperties Method
Opens the user interface to view or modify the properties of a locator.
Public Function LocatorProperties ( _
ByVal parentWindow As Integer, _
ByVal locator As ILocator, _
ByVal Title As String _
) As Boolean
public bool LocatorProperties (
int parentWindow,
ILocator locator,
string Title
);
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.
ILocatorUI.MatchTable Method
Opens the user interface to locate a table.
Public Function MatchTable ( _
ByVal parentWindow As Integer, _
ByVal tableOfLocations As ITable, _
ByVal locator As ILocator, _
ByRef pathForGxBrowser As String _
) As IName
public IName MatchTable (
int parentWindow,
ITable tableOfLocations,
ILocator locator,
ref string pathForGxBrowser
);
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.
Classes that implement ILocatorUI
| Classes | Description |
|---|
Remarks
The ILocatorUI interface is available, but the LocatorUI object is not using the ArcGIS Engine license.