com.esri.arcgis.cartoUI
Interface IIdentifyDialog2

All Superinterfaces:

Serializable

All Known Implementing Classes:

IdentifyDialog

public interface IIdentifyDialog2
extends Serializable

Provides access to members that control Identifying tables by OID.

Remarks

IIdentifyDialog2 completes the IIdentifyDialog interface by adding the following properties and methods:

AddLayerIdentifyObject is similar to AddLayerIdentifyPoint but restricts the search to the object passed as the second parameter. This is useful to sort out features that can be stacked on the same location.

AddTableIdentifyOID allows you to display the content of a table row in the identify window. This is useful to browse the content of a stand alone table. The first parameter is the table to search and the third one is the OID to look for. In case the layer or stand alone table does not have an OID it is possible to pass a table having OIDs on which the search will be performed as the second parameter. The table name displayed in the dialog will be the name of the first table but the data shown will be read from the second table. It is up to you to build this table, use another table that bears some relation with the first one, etc

More specifically, the first object must support IAttributeTable. Only objects like layers and stand alone table support this interface (thye also support ITable). The second object, if used, must be geodatabase table or a feature class and will have an OID column. Typically it will support ITable and the ITable::HasOID property should return true.

BasicMap, is the common map interface used by a number of applications in the ArcGIS suite such as MapGlobe, MapScene, etc.

HideContextMenu indicates if the context menu for identify results will show or not when the user right-clicks in the Identify Dialog. HideLayersComboBox indicates whether to hide Layers ComboBox in Identify Dialog.
SelectLayer selects a specific layer in the combobox. This only works if the dialog is visible.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	addLayerIdentifyObject(ILayer pLayer, Object object, IPoint location) Add layer and show object hit at given location.
void	addLayerIdentifyPoint(ILayer pLayer, int x, int y, int tolerance, ITrackCancel trackCancel) Add layer and show objects that contain the given point.
void	addTableIdentifyOID(ITable pSTable, ITable pNewOIDCopyTable, int oid) Add table and show row of the given OID.
boolean	isHideContextMenu() Indicates if the context menu for identify results should be hidden when the user right-clicks.
boolean	isHideLayersComboBox() Indicates whether to hide Layers ComboBox in Identify Dialog.
boolean	isVisible() Indicates if the Identify Dialog is visible.
void	selectLayer(ILayer pLayer) Select a specific layer in the combobox.
void	setBasicMapByRef(IBasicMap rhs1) The basic map of identifying layers.
void	setHideContextMenu(boolean hide) Indicates if the context menu for identify results should be hidden when the user right-clicks.
void	setHideLayersComboBox(boolean pHide) Indicates whether to hide Layers ComboBox in Identify Dialog.
void	setVisible(boolean vis) Indicates if the Identify Dialog is visible.

Method Detail

addTableIdentifyOID

void addTableIdentifyOID(ITable pSTable,
                         ITable pNewOIDCopyTable,
                         int oid)
                         throws IOException,
                                AutomationException

Add table and show row of the given OID.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pSTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

pNewOIDCopyTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

oid - The oid (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the Identify Dialog is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The vis

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

void setVisible(boolean vis)
                throws IOException,
                       AutomationException

Indicates if the Identify Dialog is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

vis - The vis (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideLayersComboBox

void setHideLayersComboBox(boolean pHide)
                           throws IOException,
                                  AutomationException

Indicates whether to hide Layers ComboBox in Identify Dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pHide - The pHide (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideLayersComboBox

boolean isHideLayersComboBox()
                             throws IOException,
                                    AutomationException

Indicates whether to hide Layers ComboBox in Identify Dialog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The pHide

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBasicMapByRef

void setBasicMapByRef(IBasicMap rhs1)
                      throws IOException,
                             AutomationException

The basic map of identifying layers.

Product Availability

Available with ArcGIS Desktop.

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IBasicMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayerIdentifyPoint

void addLayerIdentifyPoint(ILayer pLayer,
                           int x,
                           int y,
                           int tolerance,
                           ITrackCancel trackCancel)
                           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)

tolerance - The tolerance (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHideContextMenu

boolean isHideContextMenu()
                          throws IOException,
                                 AutomationException

Indicates if the context menu for identify results should be hidden when the user right-clicks.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The hide

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHideContextMenu

void setHideContextMenu(boolean hide)
                        throws IOException,
                               AutomationException

Indicates if the context menu for identify results should be hidden when the user right-clicks.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

hide - The hide (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addLayerIdentifyObject

void addLayerIdentifyObject(ILayer pLayer,
                            Object object,
                            IPoint location)
                            throws IOException,
                                   AutomationException

Add layer and show object hit at given location.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

object - A reference to another Object (IUnknown) (in)

location - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectLayer

void selectLayer(ILayer pLayer)
                 throws IOException,
                        AutomationException

Select a specific layer in the combobox. This only works if the dialog is visible.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

pLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.