com.esri.arcgis.cartoUI
Interface IIdentifyDialog

All Superinterfaces:
Serializable
All Known Implementing Classes:
IdentifyDialog

public interface IIdentifyDialog
extends Serializable

Provides access to members that control Identifying layers by OID or a point.

Superseded By

IIdentifyDialog2

Remarks

Identifying features, raster cells, and so on, is simplified by the Identify- Dialog object. The IdentifyDialog object automatically performs a search on all the layers specified and populates a standard dialog box with the search results. This object makes identification easier because you donít have to manually call IIdentify::Identify on each desired layer the IdentifyDialog does this automatically and populates the results in a standard dialog box. To use the IdentifyDialog object, you must cocreate a new instance of it and set its properties this hooks it up to the current application. The object is global, however, if an instance has already been created for the application. In this case, cocreating a new one really finds the one already available. It is important to remember that only one Identify dialog box may be opened per session in ArcMap.

The primary interface on the IdentifyDialog object is IIdentifyDialog. There are two properties, Display and Map, which must be set before the object can be used. These properties tie the object to the current application, enabling it to perform searches. Typically, the Map property is set to the documentís focus map (IMxDocument::FocusMap), and the Display property is set to the focus mapís ScreenDisplay object. Features, rasters, and others are identified as they are added to the IdentifyDialog object. There are two methods for adding layers: AddLayerIdentifyOID and AddLayerIdentifyPoint. The first method searches for features based on a specific objectID (OID), and the latter searches for features based on an x,y location. Both method take an object that supports ILayer as input. Additionally the first method takes the OID of the feature to identify and the second one a couple of coordinates from which to locate the feature to identify.

The two other methods ClearLayers and Show will repectively clear the list of layers in the dialog and display the dialog.

See also IIdentifyDialogProps.

Product Availability

Available with ArcGIS Desktop.


Method Summary
 void addLayerIdentifyOID(ILayer pLayer, int oid)
          Add layer and show object of the given OID.
 void addLayerIdentifyPoint(ILayer pLayer, int x, int y)
          Add layer and show objects that contain the given point.
 void clearLayers()
          Clear shown layers.
 void setDisplayByRef(IDisplay rhs1)
          The display.
 void setMapByRef(IMap rhs1)
          The map of identifying layers.
 void show()
          Show dialog.
 

Method Detail

setMapByRef

void setMapByRef(IMap rhs1)
                 throws IOException,
                        AutomationException
The map of identifying layers.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

setDisplayByRef

void setDisplayByRef(IDisplay rhs1)
                     throws IOException,
                            AutomationException
The display.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

clearLayers

void clearLayers()
                 throws IOException,
                        AutomationException
Clear shown layers.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

addLayerIdentifyPoint

void addLayerIdentifyPoint(ILayer pLayer,
                           int x,
                           int y)
                           throws IOException,
                                  AutomationException
Add layer and show objects that contain the given point.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

addLayerIdentifyOID

void addLayerIdentifyOID(ILayer pLayer,
                         int oid)
                         throws IOException,
                                AutomationException
Add layer and show object of the given OID.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

show

void show()
          throws IOException,
                 AutomationException
Show dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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