com.esri.arcgis.cartoUI
Interface IIdentifyDialogProps

All Superinterfaces:

Serializable

All Known Implementing Classes:

IdentifyDialog

public interface IIdentifyDialogProps
extends Serializable

Provides access to members that control Identify dialog properties.

Remarks

IIdentifyDialogProps is used to access some properties of the IdentifyDialog.

The Layers property gives an enumeration of all the searchable layers in the map. TopMostOnly is read-only and gives you some information about the state of the layers combo in the dialog. True, the default means that AddLayerIdentifyPoint will restrict its search to the topmost layer. FlashEffect is currently not implemented.

See also IIdentifyDialog.

Product Availability

Available with ArcGIS Desktop.

Method Summary

short	getFlashEffect() The flash effect.
IEnumLayer	getLayers() The layers eligible for searching.
boolean	isTopmostOnly() Indicates if the search stops once a result has been found.
void	setFlashEffect(short effect) The flash effect.

Method Detail

getLayers

IEnumLayer getLayers()
                     throws IOException,
                            AutomationException

The layers eligible for searching.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTopmostOnly

boolean isTopmostOnly()
                      throws IOException,
                             AutomationException

Indicates if the search stops once a result has been found.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlashEffect

short getFlashEffect()
                     throws IOException,
                            AutomationException

The flash effect.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The effect

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlashEffect

void setFlashEffect(short effect)
                    throws IOException,
                           AutomationException

The flash effect.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

effect - The effect (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.