com.esri.arcgis.editor
Interface ISnapAgentFeedback

All Superinterfaces:

Serializable

All Known Implementing Classes:

FeatureSnap

public interface ISnapAgentFeedback
extends Serializable

Provides access to feedback in the form of a string to determine what was snapped to.

Remarks

ISnapFeedback is used to provide information when a snap agent's Snap method returns True. A small semi-transparent window is shown containing some descriptive text about what snap agent was used. The visibility of these windows in controlled by the IEditProperties2::SnapTips property.

Implement this interface when creating custom snap agents if you want to utilize this functionality. Implementing this interface is optional.

Product Availability

Available with ArcGIS Desktop.

Method Summary

String

getSnapText() Snap Agent Feedback string.

Method Detail

getSnapText

String getSnapText()
                   throws IOException,
                          AutomationException

Snap Agent Feedback string.

Remarks

SnapText is used to populate the semi-transparent window that appears when a snap agent's Snap method returns true.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.