com.esri.arcgis.carto
Interface IMapServerIdentifyResult2

All Superinterfaces:

Serializable

All Known Implementing Classes:

MapServerIdentifyResult

public interface IMapServerIdentifyResult2
extends Serializable

Provides access to the Map Server Identify Result Interface.

Product Availability

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

Method Summary

int	getFeatureId() The Feature ID of the identified object.
String	getHTMLPopup() HTML as text that can be used in popups.
int	getLayerID() The layer ID of the identified object.
String	getName() The name of the identified object.
IPropertySet	getProperties() A set of name-value pairs for the field names and values of the identified object.
IMapServerRelationships	getRelatedRows() The related rows (relationships) of the identified object.
IGeometry	getShape() The geometry of the identified object.

Method Detail

getLayerID

int getLayerID()
               throws IOException,
                      AutomationException

The layer ID of the identified object.

Product Availability

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

Returns:

The layerID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The name of the identified object.

Remarks

Name is the value from the DisplayField of the feature. When a DisplayExpression is used in the source map document, it returns the result of the DisplayExpression.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProperties

IPropertySet getProperties()
                           throws IOException,
                                  AutomationException

A set of name-value pairs for the field names and values of the identified object.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShape

IGeometry getShape()
                   throws IOException,
                          AutomationException

The geometry of the identified object.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelatedRows

IMapServerRelationships getRelatedRows()
                                       throws IOException,
                                              AutomationException

The related rows (relationships) of the identified object.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IMapServerRelationships

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHTMLPopup

String getHTMLPopup()
                    throws IOException,
                           AutomationException

HTML as text that can be used in popups.

Remarks

When esriIdentifyVisibleWithHTMLPopup or esriIdentifyTopOneWithHTMLPopup is used, Identify includes a rich html content where attributes are formatted the way author defined in the source map document.

Product Availability

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

Returns:

The htmlText

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureId

int getFeatureId()
                 throws IOException,
                        AutomationException

The Feature ID of the identified object.

Product Availability

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

Returns:

The featureId

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.