com.esri.arcgis.carto
Interface IOverposterLayerProperties2

All Superinterfaces:

Serializable

All Known Implementing Classes:

BasicOverposterLayerProperties, MaplexOverposterLayerProperties

public interface IOverposterLayerProperties2
extends Serializable

Provides access to members that control the placement of labels or symbols on top of features (barriers).

Product Availability

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

Method Summary

boolean	isBarrier() Indicates if features are treated as barriers to label/symbol placement.
boolean	isHasFeatureWeight() Indicates if the layer has a feature weight.
boolean	isPlaceLabels() Indicates if labels are placed for the layer.
boolean	isPlaceSymbols() Indicates if symbols are placed for the layer.
boolean	isTagUnplaced() Indicates if overflow labels are put into a graphics container tagged placed or unplaced.
void	setIsBarrier(boolean isBarrier) Indicates if features are treated as barriers to label/symbol placement.
void	setPlaceLabels(boolean place) Indicates if labels are placed for the layer.
void	setPlaceSymbols(boolean place) Indicates if symbols are placed for the layer.
void	setTagUnplaced(boolean value) Indicates if overflow labels are put into a graphics container tagged placed or unplaced.

Method Detail

setPlaceLabels

void setPlaceLabels(boolean place)
                    throws IOException,
                           AutomationException

Indicates if labels are placed for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

place - The place (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPlaceLabels

boolean isPlaceLabels()
                      throws IOException,
                             AutomationException

Indicates if labels are placed for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The place

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPlaceSymbols

void setPlaceSymbols(boolean place)
                     throws IOException,
                            AutomationException

Indicates if symbols are placed for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

place - The place (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPlaceSymbols

boolean isPlaceSymbols()
                       throws IOException,
                              AutomationException

Indicates if symbols are placed for the layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The place

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsBarrier

void setIsBarrier(boolean isBarrier)
                  throws IOException,
                         AutomationException

Indicates if features are treated as barriers to label/symbol placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

isBarrier - The isBarrier (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBarrier

boolean isBarrier()
                  throws IOException,
                         AutomationException

Indicates if features are treated as barriers to label/symbol placement.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The isBarrier

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTagUnplaced

boolean isTagUnplaced()
                      throws IOException,
                             AutomationException

Indicates if overflow labels are put into a graphics container tagged placed or unplaced.

Remarks

This property specifies whether or not unplaced labels are drawn for this label class. Setting TagUnplaced to True specifies that unplaced labels will not be drawn. Setting it to False specifies that they will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTagUnplaced

void setTagUnplaced(boolean value)
                    throws IOException,
                           AutomationException

Indicates if overflow labels are put into a graphics container tagged placed or unplaced.

Remarks

This property specifies whether or not unplaced labels are drawn for this label class. Setting TagUnplaced to True specifies that unplaced labels will not be drawn. Setting it to False specifies that they will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHasFeatureWeight

boolean isHasFeatureWeight()
                           throws IOException,
                                  AutomationException

Indicates if the layer has a feature weight.

Product Availability

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

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.