com.esri.arcgis.editor
Interface ISnappingWindow

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISnappingWindowProxy

public interface ISnappingWindow
extends Serializable

Provides access to methods for working with the snapping window.

Remarks

The snapping window reveals all of the snap agents registered in the snap agent component category. Custom snap agents appear in the bottom half of the snapping window.

The first time the snapping window is opened, a feature snap agent is created for each editable featureclass. Each feature snap agent initially has its HitType property set to esriGeometryPartNone. Change the HitType by checking the appropriate box in the snapping window or programmatically change it using IFeatureSnapAgent::HitType.

Snap agents other than feature snap agents, Snap Perpendicular for example, are not instantiated the first time the snapping window is opened. Instead, these snap agents are created only when they are checked off in the snapping window or instantiated programmatically.

Call RefreshContents to update the snapping window with any programmatic changes made to the snapping environment.

To get a handle to the snapping window use IEditor::FindExtension.

When To Use

Use the ISnappingWindow interface after programmatically changing the snapping environment to refresh the contents of the Snapping Window. You can also programmatically close or open the snapping window using the Hide and Show methods.

Product Availability

Available with ArcGIS Desktop.

See Also:

ISnapEnvironment

Method Summary

void	hide() Hides the window.
void	refreshContents() Refreshes the contents.
void	show() Shows the window.

Method Detail

show

void show()
          throws IOException,
                 AutomationException

Shows the window.

Remarks

Call this method to display the snapping window.

The first time the snapping window is opened, a feature snap agent is created for each editable featureclass.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hide

void hide()
          throws IOException,
                 AutomationException

Hides the window.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshContents

void refreshContents()
                     throws IOException,
                            AutomationException

Refreshes the contents.

Remarks

Any changes made to the Snapping Environment such as turning on/off snap agents will not refresh the dialog if it is visible. After making changes to the snapping environment you should issue RefreshContents to ensure they are up to date.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.