com.esri.arcgis.carto
Interface IBarrierProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

CadAnnotationLayer, CompositeGraphicsLayer, CoverageAnnotationLayer, DimensionLayer, FDOGraphicsLayer, GraphicsSubLayer, IBarrierPropertiesProxy

public interface IBarrierProperties
extends Serializable

Provides access to members that control how objects (text, features, graphics) act as barriers for labelling.

Product Availability

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

Method Summary

void	getBarriers(IDisplay display, IGeometryCollection pBarriers, IEnvelope extent) List of barriers within the specified extent, or all barriers if no extent given.
int	getWeight() Weight of the barriers in this layer.
void	setWeight(int weight) Weight of the barriers in this layer.

Method Detail

getWeight

int getWeight()
              throws IOException,
                     AutomationException

Weight of the barriers in this layer.

Description

A Long value corresponding to a weight in esriBasicOverposterWeight.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The weight

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWeight

void setWeight(int weight)
               throws IOException,
                      AutomationException

Weight of the barriers in this layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

weight - The weight (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBarriers

void getBarriers(IDisplay display,
                 IGeometryCollection pBarriers,
                 IEnvelope extent)
                 throws IOException,
                        AutomationException

List of barriers within the specified extent, or all barriers if no extent given.

Product Availability

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

Parameters:

display - A reference to a com.esri.arcgis.display.IDisplay (in)

pBarriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.