com.esri.arcgis.carto
Interface IContextAnalyzer

All Superinterfaces:

Serializable

All Known Implementing Classes:

BasemapSubLayerRasterLayerContextAnalyzer, GroupLayerContextAnalyzer, IContextAnalyzerProxy, ImageServerLayerContextAnalyzer, IMSSubLayerContextAnalyzer, MapViewCommandsContextAnalyzer, RasterBasemapLayerContextAnalyzer, RasterLayerContextAnalyzer

public interface IContextAnalyzer
extends Serializable

Provides access to members used to determine the correct context menu id for a given context object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

void	getContextMenu(Object contextObject, IUID[] clsidMenu) Returns an appropriate context menu id, if possible.
int	getPriority() Priority for the context analyzer: 0 (highest) - 99 (lowest).
void	setPriority(int priority) Priority for the context analyzer: 0 (highest) - 99 (lowest).

Method Detail

getPriority

int getPriority()
                throws IOException,
                       AutomationException

Priority for the context analyzer: 0 (highest) - 99 (lowest).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The priority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPriority

void setPriority(int priority)
                 throws IOException,
                        AutomationException

Priority for the context analyzer: 0 (highest) - 99 (lowest).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

priority - The priority (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getContextMenu

void getContextMenu(Object contextObject,
                    IUID[] clsidMenu)
                    throws IOException,
                           AutomationException

Returns an appropriate context menu id, if possible. Returns null if it cannot determine an applicable context menu.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

contextObject - A reference to another Object (IUnknown) (in)

clsidMenu - A reference to a com.esri.arcgis.system.IUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.