ILocatorUI.CreateLocator Method

Opens the user interface to create a new locator.

[Visual Basic .NET]
Public Function CreateLocator ( _
    ByVal parentWindow As Integer, _
    ByVal locatorStyle As ILocatorStyle, _
    ByVal locWks As ILocatorWorkspace, _
    ByVal connectionName As String _
) As ILocator

[C#]
public ILocator CreateLocator (
    int parentWindow,
    ILocatorStyle locatorStyle,
    ILocatorWorkspace locWks,
    string connectionName
);

[C++]
HRESULT CreateLocator(
  OLE_HANDLE parentWindow,
  ILocatorStyle* locatorStyle,
  ILocatorWorkspace* locWks,
  BSTR connectionName,
  ILocator** locator
);

[C++]
Parameters
parentWindow [in]
  parentWindow is a parameter of type OLE_HANDLE
locatorStyle [in]
  locatorStyle is a parameter of type ILocatorStyle
locWks [in]
  locWks is a parameter of type ILocatorWorkspace
connectionName [in]
  connectionName is a parameter of type BSTR
locator [out, retval]
  locator is a parameter of type ILocator

Product Availability

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.

See Also

ILocatorUI Interface