ILocatorUI.LocatorProperties Method

Opens the user interface to view or modify the properties of a locator.

[Visual Basic .NET]
Public Function LocatorProperties ( _
    ByVal parentWindow As Integer, _
    ByVal locator As ILocator, _
    ByVal title As String _
) As Boolean

[C#]
public bool LocatorProperties (
    int parentWindow,
    ILocator locator,
    string title
);

[C++]
HRESULT LocatorProperties(
  OLE_HANDLE parentWindow,
  ILocator* locator,
  BSTR title,
  VARIANT_BOOL* Ok
);

[C++]
Parameters
parentWindow [in]
  parentWindow is a parameter of type OLE_HANDLE
locator [in]
  locator is a parameter of type ILocator
title [in]
  title is a parameter of type BSTR
Ok [out, retval]
  Ok is a parameter of type VARIANT_BOOL

Product Availability

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.

See Also

ILocatorUI Interface