com.esri.arcgis.carto
Interface IIdentifyObj

All Superinterfaces:
Serializable
All Known Implementing Classes:
GlobeServerIdentifyObject, IIdentifyObjProxy, RasterIdentifyObj, SchematicSimpleIdentifyObject, SimpleIdentifyObject, SimpleMapServerIdentifyObject, SimpleRasterIdentifyObj, SimpleTinIdentifyObj, SimpleWMSIdentifyObject

public interface IIdentifyObj
extends Serializable

Provides access to members that control feature identification for a layer.

Remarks

When used on a map layer, the IIdentify::Identify method returns an array of FeatureIdentifyObject objects. On a FeatureIdentifyObject, you can do a QI to this IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

The Flash method is not supported with ArcGIS Engine, use the IHookActions.DoActions() method with the esriHookActionsFlash for this functionality.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

See Also:
IIdentify, IFeatureIdentifyObj, com.esri.arcgis.cartoUI.FeatureIdentifyObject

Method Summary
 boolean canIdentify(ILayer pLayer)
          Indicates if the object can identify the specified layer.
 void flash(IScreenDisplay pDisplay)
          Flashes the identified object on the screen.
 int getHWnd()
          The window handle.
 ILayer getLayer()
          Target layer for identification.
 String getName()
          Name of the identify object.
 void popUpMenu(int x, int y)
          Displays a context sensitive popup menu at the specified location.
 

Method Detail

canIdentify

boolean canIdentify(ILayer pLayer)
                    throws IOException,
                           AutomationException
Indicates if the object can identify the specified layer.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)
Returns:
The b
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHWnd

int getHWnd()
            throws IOException,
                   AutomationException
The window handle.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The hWnd (A COM typedef)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException
Name of the identify object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer()
                throws IOException,
                       AutomationException
Target layer for identification.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

flash

void flash(IScreenDisplay pDisplay)
           throws IOException,
                  AutomationException
Flashes the identified object on the screen.

Remarks

The Flash method is not supported with ArcGIS Engine, use the IHookActions.DoActions() method with the esriHookActionsFlash for this functionality.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pDisplay - A reference to a com.esri.arcgis.display.IScreenDisplay (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

popUpMenu

void popUpMenu(int x,
               int y)
               throws IOException,
                      AutomationException
Displays a context sensitive popup menu at the specified location.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
x - The x (in)
y - The y (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.