com.esri.arcgis.controls
Interface ISnappingFeedback

All Superinterfaces:
Serializable
All Known Implementing Classes:
ISnappingFeedbackProxy, SnappingFeedback

public interface ISnappingFeedback
extends Serializable

ISnappingFeedback Interface

Product Availability

Available with ArcGIS Engine.


Method Summary
 void initialize(Object hook, ISnappingEnvironment snapEnv, boolean autoErase)
          Initialize with the current snapping environment.
 void refresh(int hdc)
          Refresh the last update.
 void unInitialize()
          Disconnecting from the View.
 void update(ISnappingResult snappingResult, int hdc)
          Sets the current mouse location and snap result.
 

Method Detail

initialize

void initialize(Object hook,
                ISnappingEnvironment snapEnv,
                boolean autoErase)
                throws IOException,
                       AutomationException
Initialize with the current snapping environment.

Remarks

Initialize sets up a SnappingFeedback class with the appropriate snap symbol as defined on snapping environment.

Product Availability

Available with ArcGIS Engine.

Parameters:
hook - A reference to another Automation Object (IDispatch) (in)
snapEnv - A reference to a com.esri.arcgis.controls.ISnappingEnvironment (in)
autoErase - The autoErase (in, optional, pass true if not required)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

unInitialize

void unInitialize()
                  throws IOException,
                         AutomationException
Disconnecting from the View.

Remarks

Uninitialize releases any references to the snapping environment and application specified in ISnappingFeedback.Initialize.

Product Availability

Available with ArcGIS Engine.

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

update

void update(ISnappingResult snappingResult,
            int hdc)
            throws IOException,
                   AutomationException
Sets the current mouse location and snap result.

Remarks

Update notifies the snapping feedback object that changes in the snap location may have occurred. The Update method uses the snapResult object that is passed in to display the snapping symbol and snap tip if a snap occurred, and draws them on the hDC passed in. Calls to Update are usually made in conjunction with calls to IPointSnapper.Snap() inside a toolís MouseMove() method. Even if a null snap result is returned, your code should ensure that Update is called; a null SnapResult passed into the Update method() is fine.

Product Availability

Available with ArcGIS Engine.

Parameters:
snappingResult - A reference to a com.esri.arcgis.controls.ISnappingResult (in)
hdc - The hdc (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

void refresh(int hdc)
             throws IOException,
                    AutomationException
Refresh the last update.

Remarks

A call to Refresh invalidates the previous location of the SnapTip and the snap symbol, and draws the new feedback. When a tool is utilizing the snapping environment, ISnappingFeedback.Refresh() should be called in the toolís refresh method.

Product Availability

Available with ArcGIS Engine.

Parameters:
hdc - The hdc (A COM typedef) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.