com.esri.arcgis.controls
Interface IEngineSnapAgentCategory

All Superinterfaces:

Serializable

All Known Implementing Classes:

IEngineSnapAgentCategoryProxy

public interface IEngineSnapAgentCategory
extends Serializable

Provides access to the category of an engine snap agent.

Remarks

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

When To Use

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

Product Availability

Available with ArcGIS Engine.

Method Summary

String

getCategory() The engine snap agent category.

Method Detail

getCategory

String getCategory()
                   throws IOException,
                          AutomationException

The engine snap agent category.

Description

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

Product Availability

Available with ArcGIS Engine.

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.