com.esri.arcgis.editor
Interface ISnapAgentCategory

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISnapAgentCategoryProxy

public interface ISnapAgentCategory
extends Serializable

Provides access to the categories of SnapAgents.

Remarks

FeatureSnap agents do not implement this interface. You should check the type of SnapAgent before attempting to access this interface.

When To Use

ISnapAgentCategory provides a mechanism to organize and group SnapAgents. Custom SnapAgents are listed in the lower half of the Editor's Snapping dialog. Implement this interface if you want to place your snap agent into a particular category.

Product Availability

Available with ArcGIS Desktop.

Method Summary

String

getCategory() The Snap Agent category.

Method Detail

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

The Snap Agent category.

Description

Category returns the name of each top-level node in the lower-half of the Editor's Snapping Environment dialog.

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.