com.esri.arcgis.carto
Interface IDynamicLegendLayer

All Superinterfaces:

Serializable

public interface IDynamicLegendLayer
extends Serializable

Provides access to members that control dynamic legend information provided by a layer.

Product Availability

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

Method Summary

void	instrumentedDraw(int type, IDisplay pMapDisplay, IGeometry mapExtent, ITrackCancel trackCancel) Update counts in legend classes.
boolean	isDynamicLegendInfoDirty() Indicates that the layer appearance has changed and dynamic legend info needs updating.
void	refreshDynamicLegendInfo() Call when layer appearance or visible extent changes.

Method Detail

isDynamicLegendInfoDirty

boolean isDynamicLegendInfoDirty()
                                 throws IOException,
                                        AutomationException

Indicates that the layer appearance has changed and dynamic legend info needs updating.

Product Availability

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

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshDynamicLegendInfo

void refreshDynamicLegendInfo()
                              throws IOException,
                                     AutomationException

Call when layer appearance or visible extent changes.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

instrumentedDraw

void instrumentedDraw(int type,
                      IDisplay pMapDisplay,
                      IGeometry mapExtent,
                      ITrackCancel trackCancel)
                      throws IOException,
                             AutomationException

Update counts in legend classes. Specify NULL geometry to clear counts.

Product Availability

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

Parameters:

type - A com.esri.arcgis.carto.esriDynamicLegendType constant (in)

pMapDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)

mapExtent - A reference to a com.esri.arcgis.geometry.IGeometry (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.