com.esri.arcgis.carto
Interface IDynamicLegendItem

All Superinterfaces:

Serializable

public interface IDynamicLegendItem
extends Serializable

Dynamic legend properties

Product Availability

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

Method Summary

INumberFormat	getCountNumberFormat() Class count number format.
String	getCountPrefix() Class count string is created by combining prefix + count + suffix.
String	getCountSuffix() Class count string is created by combining prefix + count + suffix.
boolean	isAutoVisibility() Indicates if classes should be shown only when associated data is visible.
boolean	isShowCounts() Show the number of times a class appears in the current map extent.
boolean	isUseSimpleExtent() Indicates geometry used to determine whether the data for a legend class is visible.
void	setAutoVisibility(boolean autoVisibility) Indicates if classes should be shown only when associated data is visible.
void	setCountNumberFormatByRef(INumberFormat format) Class count number format.
void	setCountPrefix(String str) Class count string is created by combining prefix + count + suffix.
void	setCountSuffix(String str) Class count string is created by combining prefix + count + suffix.
void	setShowCounts(boolean autoVisibility) Show the number of times a class appears in the current map extent.
void	setUseSimpleExtent(boolean flag) Indicates geometry used to determine whether the data for a legend class is visible.

Method Detail

isAutoVisibility

boolean isAutoVisibility()
                         throws IOException,
                                AutomationException

Indicates if classes should be shown only when associated data is visible.

Product Availability

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

Returns:

The autoVisibility

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoVisibility

void setAutoVisibility(boolean autoVisibility)
                       throws IOException,
                              AutomationException

Indicates if classes should be shown only when associated data is visible.

Product Availability

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

Parameters:

autoVisibility - The autoVisibility (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSimpleExtent

boolean isUseSimpleExtent()
                          throws IOException,
                                 AutomationException

Indicates geometry used to determine whether the data for a legend class is visible. Normally, the map clip shape or data driven page index feature is used. Simple means use the data frame extent.

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.

setUseSimpleExtent

void setUseSimpleExtent(boolean flag)
                        throws IOException,
                               AutomationException

Indicates geometry used to determine whether the data for a legend class is visible. Normally, the map clip shape or data driven page index feature is used. Simple means use the data frame extent.

Product Availability

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

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowCounts

boolean isShowCounts()
                     throws IOException,
                            AutomationException

Show the number of times a class appears in the current map extent.

Product Availability

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

Returns:

The autoVisibility

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowCounts

void setShowCounts(boolean autoVisibility)
                   throws IOException,
                          AutomationException

Show the number of times a class appears in the current map extent.

Product Availability

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

Parameters:

autoVisibility - The autoVisibility (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCountPrefix

String getCountPrefix()
                      throws IOException,
                             AutomationException

Class count string is created by combining prefix + count + suffix.

Product Availability

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

Returns:

The str

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCountSuffix

void setCountSuffix(String str)
                    throws IOException,
                           AutomationException

Class count string is created by combining prefix + count + suffix.

Product Availability

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

Parameters:

str - The str (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCountSuffix

String getCountSuffix()
                      throws IOException,
                             AutomationException

Class count string is created by combining prefix + count + suffix.

Product Availability

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

Returns:

The str

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCountPrefix

void setCountPrefix(String str)
                    throws IOException,
                           AutomationException

Class count string is created by combining prefix + count + suffix.

Product Availability

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

Parameters:

str - The str (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCountNumberFormat

INumberFormat getCountNumberFormat()
                                   throws IOException,
                                          AutomationException

Class count number format.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.INumberFormat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCountNumberFormatByRef

void setCountNumberFormatByRef(INumberFormat format)
                               throws IOException,
                                      AutomationException

Class count number format.

Product Availability

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

Parameters:

format - A reference to a com.esri.arcgis.system.INumberFormat (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.