com.esri.arcgis.carto
Interface ILabelStyle2

All Superinterfaces:

Serializable

All Known Implementing Classes:

LabelStyle, MaplexLabelStyle

public interface ILabelStyle2
extends Serializable

Provides access to members that control the label symbol and placement properties.

Product Availability

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

Method Summary

IBasicOverposterLayerProperties	getBasicOverposterLayerProperties() The overposter properties, which specify how labels are placed relative to features.
IOverposterLayerProperties	getOverposterLayerProperties() The overposter properties, which specify how labels are placed relative to features.
ITextSymbol	getSymbol() The text symbol used to draw the label.
void	setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props) The overposter properties, which specify how labels are placed relative to features.
void	setOverposterLayerPropertiesByRef(IOverposterLayerProperties props) The overposter properties, which specify how labels are placed relative to features.
void	setSymbolByRef(ITextSymbol textSymbol) The text symbol used to draw the label.

Method Detail

setSymbolByRef

void setSymbolByRef(ITextSymbol textSymbol)
                    throws IOException,
                           AutomationException

The text symbol used to draw the label.

Product Availability

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

Parameters:

textSymbol - 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.

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.

Supported Platforms

Windows, Solaris, Linux

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.

setBasicOverposterLayerPropertiesByRef

void setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
                                            throws IOException,
                                                   AutomationException

The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Parameters:

props - A reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBasicOverposterLayerProperties

IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
                                                                  throws IOException,
                                                                         AutomationException

The overposter properties, which specify how labels are placed relative to features.

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.IBasicOverposterLayerProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOverposterLayerPropertiesByRef

void setOverposterLayerPropertiesByRef(IOverposterLayerProperties props)
                                       throws IOException,
                                              AutomationException

The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Parameters:

props - A reference to a com.esri.arcgis.carto.IOverposterLayerProperties (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOverposterLayerProperties

IOverposterLayerProperties getOverposterLayerProperties()
                                                        throws IOException,
                                                               AutomationException

The overposter properties, which specify how labels are placed relative to features.

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.IOverposterLayerProperties

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.