Interface ILocatorWorkspace

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll

Provides access to members for managing the locators in the locator workspace.

[Guid("AE5A3A08-F756-11D2-9F4F-00C04F8ED1C4")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ILocatorWorkspace

Remarks

For some of the members of this interface, you must specify a Category string parameter. You can use categories to organize your locators and locator styles. All of the locators and locator styles provided with ArcGIS have a category of “Address”.

Properties

LocatorNames[esriLocatorQuery, string]

LocatorName objects in the locator workspace.

IEnumLocatorName LocatorNames[esriLocatorQuery queryType, string Category] { get; }

Parameters

queryType esriLocatorQuery
Category string

Property Value

IEnumLocatorName

Remarks

The LocatorNames property returns a LocatorNameEnumerator containing LocatorName objects representing locators in the locator workspace.

Use the queryType parameter to specify whether to include locators, locator styles, or both in the LocatorNameEnumerator.

Use the Category parameter to specify which category of locators and locator styles to include in the LocatorNameEnumerator. Address locators and address locator styles provided with ArcGIS all have a category of "Address". Specify an empty string for the Category parameter if you want to include locators or locator styles from all categories.

Locators[esriLocatorQuery, string]

Locators in the locator workspace.

IEnumLocator Locators[esriLocatorQuery queryType, string Category] { get; }

Parameters

queryType esriLocatorQuery
Category string

Property Value

IEnumLocator

Remarks

The Locators property returns a LocatorEnumerator containing locators from the locator workspace.

Use the queryType parameter to specify whether to include locators, locator styles, or both in the LocatorEnumerator.

Use the Category parameter to specify which category of locators and locator styles to include in the LocatorEnumerator. Address locators and address locator styles provided with ArcGIS all have a category of "Address". Specify an empty string for the Category parameter if you want to include locators or locator styles from all categories.

Name

The Name object for the locator workspace.

ILocatorWorkspaceName Name { get; }

Property Value

ILocatorWorkspaceName

Methods

AddLocator(string, ILocator, string, ITrackCancel)

Adds a locator to the locator workspace.

ILocator AddLocator(string Name, ILocator locator, string ConfigKeyword, ITrackCancel CancelTracker)

Parameters

Name string
locator ILocator
ConfigKeyword string
CancelTracker ITrackCancel

Returns

ILocator

Remarks

In general, when creating a locator, you will first retrieve a locator style from the locator workspace, set the properties on the locator style, then use the AddLocator method to create a new locator.

The Name parameter specifies the name for the new locator.

The Locator parameter is a reference to the locator that you want to add to the locator workspace.

The ConfigKeyword parameter is used to specify the ArcSDE storage keyword used to create the reference data indexes for the new locator. This parameter is only used if the locator workspace is in an ArcSDE database. Using a configuration keyword specifies certain parameters for storing tables to the ArcSDE database, and the proper configuration can improve the performance of your locators. For more information on ArcSDE configuration keywords, refer to the ArcSDE Configuration and Tuning Guide for your relational database management system (RDBMS). To use the default storage keyword for the ArcSDE database, specify a blank string for this parameter.

ICancelTracker is an optional parameter that you can use to specify a CancelTracker object that is used to display the reference data index building progress and allows the user to cancel the process.

AddLocatorStyle(string, string, ILocatorStyle)

Adds a locator style.

void AddLocatorStyle(string Name, string Category, ILocatorStyle locatorStyle)

Parameters

Name string
Category string
locatorStyle ILocatorStyle

Remarks

In general, you will only use this method if you have created your own custom locator style and want to copy it from one locator workspace to another.

The Name parameter specifies the name for the new locator style.

The Category parameter is used to specify the category of the new locator style. Address locator styles provided with ArcGIS all have a category of "Address".

The LocatorStyle parameter is a reference to the locator style to add to the locator workspace.

CopyLocator(string, string)

Copies a locator.

void CopyLocator(string srcName, string dstName)

Parameters

srcName string
dstName string

Remarks

The srcName parameter is the name of the locator that you want to copy. The dstName parameter is the name for the copy of the locator.

In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator".  When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.  

 

DeleteLocator(string)

Deletes a locator.

void DeleteLocator(string Name)

Parameters

Name string

Remarks

The Name parameter is the name of the locator or locator style that you want to remove from the locator workspace.

In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator".  When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.  

GetLocator(string)

Gets a locator.

ILocator GetLocator(string Name)

Parameters

Name string

Returns

ILocator

Remarks

The Name parameter is the name of the locator that you want to retrieve from the locator workspace.

Within the default local locator workspace, and within ArcSDE locator workspaces, locator names are prefixed by a user name, as in "jack.My Locator". In local locator workspaces, the locator name is prefixed by the user name of the current user. In ArcSDE workspaces, the locator name is prefixed by the name of the ArcSDE user that owns the locator. When you call methods in ArcObjects that have parameters that specify locators in a locator workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.  

GetLocatorName(string)

Gets a LocatorName object.

ILocatorName GetLocatorName(string Name)

Parameters

Name string

Returns

ILocatorName

Remarks

The Name parameter is the name of the locator that you want to retrieve from the locator workspace.

In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator".  When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error. 

GetLocatorStyle(string)

Gets a locator style.

ILocatorStyle GetLocatorStyle(string Name)

Parameters

Name string

Returns

ILocatorStyle

Remarks

The Name parameter is the name of the locator style that you want to retrieve from the locator workspace.

Within ArcSDE locator workspaces, locator style names are prefixed by the name of the SDE user that owns the locator style (usually the default SDE user), as in "SDE.US Streets with Zone". You must specify the SDE user as a part of the Name parameter when calling the GetLocatorStyle method on an ArcSDE locator workspace.

RenameLocator(string, string)

Renames a locator.

void RenameLocator(string oldName, string newName)

Parameters

oldName string
newName string

Remarks

The oldName parameter is the current name of the locator or locator style that you want to rename. The newName parameter is the new name for the locator or locator style.

In ArcSDE workspaces, locator names are prefixed by the name of the ArcSDE user that owns the locator, as in "jack.My Locator".  When you call methods in ArcObjects that have parameters that specify locators in a ArcSDE workspace, you must specify the full name of the locator, including the user name. Failing to do so will result in an error.  You must fully-qualify the oldName parameter with a user name. Do not qualify the newName parameter with a user name; the locator workspace will add the user name automatically.

UpdateLocator(ILocator)

Modifies the properties of a locator.

void UpdateLocator(ILocator locator)

Parameters

locator ILocator

Remarks

To update a locator or locator style, first get the locator or locator style from the locator workspace using one of the members of the ILocatorWorkspace interface. Modify the properties of the locator or locator style, then update the locator or locator style using this method.