com.esri.arcgis.carto
Interface ILabelClassDescription

All Superinterfaces:
Serializable
All Known Implementing Classes:
LabelClassDescription

public interface ILabelClassDescription
extends Serializable

Provides access to the Label Class Description Interface.

Product Availability

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


Method Summary
 String getLabelExpression()
          The Label Expression.
 ILabelPlacementDescription getLabelPlacementDescription()
          LabelPlacementDescription.
 double getMaximumScale()
          Maximum scale at which the symbol will display.
 double getMinimumScale()
          Minimum scale at which the symbol will display.
 ITextSymbol getSymbol()
          The text symbol used to draw the label.
 boolean isUseCodedValue()
          Indicates whether Coded Value Should be used when displaying label expression.
 void setLabelExpression(String labelExpression)
          The Label Expression.
 void setLabelPlacementDescription(ILabelPlacementDescription ppLabelPlacementDescription)
          LabelPlacementDescription.
 void setMaximumScale(double pMaximumScale)
          Maximum scale at which the symbol will display.
 void setMinimumScale(double pMinimumScale)
          Minimum scale at which the symbol will display.
 void setSymbol(ITextSymbol ppSymbol)
          The text symbol used to draw the label.
 void setUseCodedValue(boolean useCodedValue)
          Indicates whether Coded Value Should be used when displaying label expression.
 

Method Detail

getLabelPlacementDescription

ILabelPlacementDescription getLabelPlacementDescription()
                                                        throws IOException,
                                                               AutomationException
LabelPlacementDescription.

Remarks

LabelPlacementDescription returns one of three placement description objects depends on the geometry type of the layer – PointLabelPlacementDescription, LineLabelPlacementDescription or PolygonLabelPlacementDescription.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.carto.ILabelPlacementDescription
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelPlacementDescription

void setLabelPlacementDescription(ILabelPlacementDescription ppLabelPlacementDescription)
                                  throws IOException,
                                         AutomationException
LabelPlacementDescription.

Product Availability

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

Parameters:
ppLabelPlacementDescription - A reference to a com.esri.arcgis.carto.ILabelPlacementDescription (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelExpression

String getLabelExpression()
                          throws IOException,
                                 AutomationException
The Label Expression.

Remarks

Please note that LabelExpression either returns a field name or a simple expression set for a layer. A simple expression could be a concatenation of attribute values from two fields, for example first and last name of a parcel owner. MapServer drops any advanced expression set on the layer in the source map document and returns an empty string.

Product Availability

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

Returns:
The labelExpression
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelExpression

void setLabelExpression(String labelExpression)
                        throws IOException,
                               AutomationException
The Label Expression.

Product Availability

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

Parameters:
labelExpression - The labelExpression (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseCodedValue

boolean isUseCodedValue()
                        throws IOException,
                               AutomationException
Indicates whether Coded Value Should be used when displaying label expression.

Product Availability

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

Returns:
The useCodedValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseCodedValue

void setUseCodedValue(boolean useCodedValue)
                      throws IOException,
                             AutomationException
Indicates whether Coded Value Should be used when displaying label expression.

Product Availability

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

Parameters:
useCodedValue - The useCodedValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbol

ITextSymbol getSymbol()
                      throws IOException,
                             AutomationException
The text symbol used to draw the label.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbol

void setSymbol(ITextSymbol ppSymbol)
               throws IOException,
                      AutomationException
The text symbol used to draw the label.

Product Availability

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

Parameters:
ppSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumScale

double getMaximumScale()
                       throws IOException,
                              AutomationException
Maximum scale at which the symbol will display.

Remarks

When the MaximumScale is specified, features will not be labeled when zooming in beyond that scale. For example, if the MaximumScale is 500, labels will not display when zoomed in beyond 1:500.

Product Availability

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

Returns:
The pMaximumScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumScale

void setMaximumScale(double pMaximumScale)
                     throws IOException,
                            AutomationException
Maximum scale at which the symbol will display.

Product Availability

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

Parameters:
pMaximumScale - The pMaximumScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumScale

double getMinimumScale()
                       throws IOException,
                              AutomationException
Minimum scale at which the symbol will display.

Remarks

When the MinimumScale is specified, features will not be labeled when zooming out beyond that scale. For example, if the MaximumScale is 1000, labels will not display when zoomed out beyond 1:1000.

Product Availability

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

Returns:
The pMinimumScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumScale

void setMinimumScale(double pMinimumScale)
                     throws IOException,
                            AutomationException
Minimum scale at which the symbol will display.

Product Availability

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

Parameters:
pMinimumScale - The pMinimumScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.