ILocatorWorkspace Interface

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

When To Use

Use the ILocatorWorkspace interface to manage the****locators and locator styles in the locator workspace. You can use this interface to retrieve locators and locator styles from the locator workspace, as well as create, modify, and delete locators in the locator workspace.

Members

	Name	Description
	AddLocator	Adds a locator to the locator workspace.
	AddLocatorStyle	Adds a locator style.
	CopyLocator	Copies a locator.
	DeleteLocator	Deletes a locator.
	GetLocator	Gets a locator.
	GetLocatorName	Gets a LocatorName object.
	GetLocatorStyle	Gets a locator style.
	LocatorNames	LocatorName objects in the locator workspace.
	Locators	Locators in the locator workspace.
	Name	The Name object for the locator workspace.
	RenameLocator	Renames a locator.
	UpdateLocator	Modifies the properties of a locator.

ILocatorWorkspace.AddLocator Method

Adds a locator to the locator workspace.

Public Function AddLocator ( _
    ByVal Name As String, _
    ByVal locator As ILocator, _
    ByVal ConfigKeyword As String, _
    ByVal CancelTracker As ITrackCancel _
) As ILocator

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

Description

The AddLocator method adds the specified locator to the locator workspace with the specified name.

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.

ILocatorWorkspace.AddLocatorStyle Method

Adds a locator style.

Public Sub AddLocatorStyle ( _
    ByVal Name As String, _
    ByVal Category As String, _
    ByVal locatorStyle As ILocatorStyle _
)

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

Description

The AddLocatorStyle method adds the specified locator style to the locator workspace.

Note: This method is deprecated in versions of ArcGIS later than 9.3.1.

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.

ILocatorWorkspace.CopyLocator Method

Copies a locator.

Public Sub CopyLocator ( _
    ByVal srcName As String, _
    ByVal dstName As String _
)

public void CopyLocator (
    string srcName,
    string dstName
);

Description

The CopyLocator method creates a copy of the specified locator in the same locator workspace.

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.

ILocatorWorkspace.DeleteLocator Method

Deletes a locator.

Public Sub DeleteLocator ( _
    ByVal Name As String _
)

public void DeleteLocator (
    string Name
);

Description

The DeleteLocator method deletes a locator or locator style from a locator workspace.

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.

ILocatorWorkspace.GetLocator Method

Gets a locator.

Public Function GetLocator ( _
    ByVal Name As String _
) As ILocator

public ILocator GetLocator (
    string Name
);

Description

The GetLocator method retrieves a locator from a locator workspace.

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.

ILocatorWorkspace.GetLocatorName Method

Gets a LocatorName object.

Public Function GetLocatorName ( _
    ByVal Name As String _
) As ILocatorName

public ILocatorName GetLocatorName (
    string Name
);

Description

The GetLocatorName method retrieves a LocatorName object from a locator workspace.

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.

ILocatorWorkspace.GetLocatorStyle Method

Gets a locator style.

Public Function GetLocatorStyle ( _
    ByVal Name As String _
) As ILocatorStyle

public ILocatorStyle GetLocatorStyle (
    string Name
);

Description

The GetLocatorStyle method retrieves a locator style from a locator workspace.

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.

ILocatorWorkspace.LocatorNames Property

LocatorName objects in the locator workspace.

Public Function get_LocatorNames ( _
    ByVal queryType As esriLocatorQuery, _
    ByVal Category As String _
) As IEnumLocatorName

public IEnumLocatorName get_LocatorNames (
    esriLocatorQuery queryType,
    string Category
);

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.

ILocatorWorkspace.Locators Property

Locators in the locator workspace.

Public Function get_Locators ( _
    ByVal queryType As esriLocatorQuery, _
    ByVal Category As String _
) As IEnumLocator

public IEnumLocator get_Locators (
    esriLocatorQuery queryType,
    string Category
);

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.

ILocatorWorkspace.Name Property

The Name object for the locator workspace.

Public ReadOnly Property Name As ILocatorWorkspaceName

public ILocatorWorkspaceName Name {get;}

Description

The Name property returns a reference to a LocatorWorkspaceName object that represents the locator workspace.

ILocatorWorkspace.RenameLocator Method

Renames a locator.

Public Sub RenameLocator ( _
    ByVal oldName As String, _
    ByVal newName As String _
)

public void RenameLocator (
    string oldName,
    string newName
);

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.

ILocatorWorkspace.UpdateLocator Method

Modifies the properties of a locator.

Public Sub UpdateLocator ( _
    ByVal locator As ILocator _
)

public void UpdateLocator (
    ILocator locator
);

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.

Classes that implement ILocatorWorkspace

Classes	Description

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�.