com.esri.arcgis.carto
Interface ILabelEnvironment

All Superinterfaces:

Serializable

All Known Implementing Classes:

LabelEnvironment

public interface ILabelEnvironment
extends Serializable

Provides access to members that work with the labeling environment.

Description

Manages settings for the Label tool which appears on ArcMap's Draw toolbar.

When To Use

The ILabelEnvironment interface maintains information about an ILabelStyle.

Product Availability

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

Method Summary

ILabelStyle	getLabelStyle() Label style.
int	getLabelStyleMethod() The label style method.
int	getPlacement() The label placement method.
void	setLabelStyleByRef(ILabelStyle labelStyle) Label style.
void	setLabelStyleMethod(int method) The label style method.
void	setPlacement(int placement) The label placement method.

Method Detail

setLabelStyleMethod

void setLabelStyleMethod(int method)
                         throws IOException,
                                AutomationException

The label style method. This indicates whether the label style comes from the feature layer or the label environment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

method - A com.esri.arcgis.carto.esriLabelEnvLabelStyleMethod constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelStyleMethod

int getLabelStyleMethod()
                        throws IOException,
                               AutomationException

The label style method. This indicates whether the label style comes from the feature layer or the label environment.

Remarks

When the Label tool is used, this property determines whether the label style (which includes label placement properties and a text symbol) is chosen by the user on the Labeling dialog, or comes from the labeling properties of the layer being labeled.

If ILabelEnvironment::Placement is set to esriPlaceWhereClick, then no label placement properties are used, and only the text symbol is taken from either the chosen label style or the layer's labeling properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriLabelEnvLabelStyleMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlacement

void setPlacement(int placement)
                  throws IOException,
                         AutomationException

The label placement method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

placement - A com.esri.arcgis.carto.esriLabelEnvPlacement constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPlacement

int getPlacement()
                 throws IOException,
                        AutomationException

The label placement method.

Remarks

When the Label tool is used, this property determines whether new labels are placed where the user clicks, or whether label placement properties are used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriLabelEnvPlacement constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabelStyleByRef

void setLabelStyleByRef(ILabelStyle labelStyle)
                        throws IOException,
                               AutomationException

Label style.

Product Availability

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

Parameters:

labelStyle - A reference to a com.esri.arcgis.carto.ILabelStyle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabelStyle

ILabelStyle getLabelStyle()
                          throws IOException,
                                 AutomationException

Label style.

Remarks

This property is only used if ILabelEnvironment::LabelStyleMethod is set to esriChooseLabelStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.carto.ILabelStyle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.