com.esri.arcgis.carto
Interface ILineLabelPosition

All Superinterfaces:

Serializable

All Known Implementing Classes:

LineLabelPosition

public interface ILineLabelPosition
extends Serializable

Provides access to members that control the relative position of line labels.

Description

The properties of this interface correspond to the settings on the label placement properties dialog in ArcMap for line features. These properties are also used for feature-linked annotation.

Remarks

Not all property value combinations are valid in ArcMap, but no validation is performed by this object. This means that you can set the properties of this object to any combination of true/false and this object will not change them for you.

When labeling occurs in ArcMap, invalid property combinations on this object can create unexpected results.

Validation does occur when the ArcMap user interface is used (i.e. the label placement properties dialog). Changes applied here by the user will change the values set on the current object.

When setting properties using this interface, it is recommended that you use the ArcMap user interface logic as a guide to setting valid property combinations. Several of these rules are described here:

• Horizontal, Parallel, and Perpendicular are exclusive, meaning that one and only one should be set to True. ProduceCurvedLabels should only be True only if Parallel is also True.
• The property pairs Above/Below and Right/Left are exclusive. To place labels based on page orientation, use Above/Below. To place labels based on line orientation, use Right/Left. Note that within these pairs you can set either or both properties to True. To be valid, at least one must be set to True.
• At Start, At End, and InLine are exclusive and at least one should be set to True. If InLine is True then each label is placed along its line feature at the best position. If InLine is False, then you can specify line placement priorities using ILineLabelPlacementPriorities.

When To Use

Manages label placement properties for line features. For example, you can use this interface to specify whether labels can be placed above, below and/or centered on the line features being labeled.

Product Availability

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

See Also:

IBasicOverposterLayerProperties

Method Summary

double	getOffset() Offset from the start/end of lines (in map units).
boolean	isAbove() Indicates if labels are placed above lines.
boolean	isAtEnd() Indicates if labels are placed at the end of lines.
boolean	isAtStart() Indicates if labels are placed at the start of lines.
boolean	isBelow() Indicates if labels are placed below lines.
boolean	isHorizontal() Indicates if labels are placed horizontally.
boolean	isInLine() Indicates if labels are placed along lines at the best position.
boolean	isLeft() Indicates if labels are placed to the left of lines.
boolean	isOnTop() Indicates if labels are placed on top of lines.
boolean	isParallel() Indicates if labels are placed parallel to lines.
boolean	isPerpendicular() Indicates if labels are placed perpendicular to lines.
boolean	isProduceCurvedLabels() Indicates if labels follow lines.
boolean	isRight() Indicates if labels are placed to the right of lines.
void	setAbove(boolean flag) Indicates if labels are placed above lines.
void	setAtEnd(boolean flag) Indicates if labels are placed at the end of lines.
void	setAtStart(boolean flag) Indicates if labels are placed at the start of lines.
void	setBelow(boolean flag) Indicates if labels are placed below lines.
void	setHorizontal(boolean flag) Indicates if labels are placed horizontally.
void	setInLine(boolean flag) Indicates if labels are placed along lines at the best position.
void	setLeft(boolean flag) Indicates if labels are placed to the left of lines.
void	setOffset(double offset) Offset from the start/end of lines (in map units).
void	setOnTop(boolean flag) Indicates if labels are placed on top of lines.
void	setParallel(boolean flag) Indicates if labels are placed parallel to lines.
void	setPerpendicular(boolean flag) Indicates if labels are placed perpendicular to lines.
void	setProduceCurvedLabels(boolean flag) Indicates if labels follow lines.
void	setRight(boolean flag) Indicates if labels are placed to the right of lines.

Method Detail

isProduceCurvedLabels

boolean isProduceCurvedLabels()
                              throws IOException,
                                     AutomationException

Indicates if labels follow lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProduceCurvedLabels

void setProduceCurvedLabels(boolean flag)
                            throws IOException,
                                   AutomationException

Indicates if labels follow lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAbove

boolean isAbove()
                throws IOException,
                       AutomationException

Indicates if labels are placed above lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAbove

void setAbove(boolean flag)
              throws IOException,
                     AutomationException

Indicates if labels are placed above lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBelow

boolean isBelow()
                throws IOException,
                       AutomationException

Indicates if labels are placed below lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBelow

void setBelow(boolean flag)
              throws IOException,
                     AutomationException

Indicates if labels are placed below lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isOnTop

boolean isOnTop()
                throws IOException,
                       AutomationException

Indicates if labels are placed on top of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOnTop

void setOnTop(boolean flag)
              throws IOException,
                     AutomationException

Indicates if labels are placed on top of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isLeft

boolean isLeft()
               throws IOException,
                      AutomationException

Indicates if labels are placed to the left of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeft

void setLeft(boolean flag)
             throws IOException,
                    AutomationException

Indicates if labels are placed to the left of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRight

boolean isRight()
                throws IOException,
                       AutomationException

Indicates if labels are placed to the right of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRight

void setRight(boolean flag)
              throws IOException,
                     AutomationException

Indicates if labels are placed to the right of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInLine

boolean isInLine()
                 throws IOException,
                        AutomationException

Indicates if labels are placed along lines at the best position.

Remarks

If True then each label is placed along its line feature at the best position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInLine

void setInLine(boolean flag)
               throws IOException,
                      AutomationException

Indicates if labels are placed along lines at the best position.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAtStart

boolean isAtStart()
                  throws IOException,
                         AutomationException

Indicates if labels are placed at the start of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAtStart

void setAtStart(boolean flag)
                throws IOException,
                       AutomationException

Indicates if labels are placed at the start of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAtEnd

boolean isAtEnd()
                throws IOException,
                       AutomationException

Indicates if labels are placed at the end of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAtEnd

void setAtEnd(boolean flag)
              throws IOException,
                     AutomationException

Indicates if labels are placed at the end of lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isParallel

boolean isParallel()
                   throws IOException,
                          AutomationException

Indicates if labels are placed parallel to lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParallel

void setParallel(boolean flag)
                 throws IOException,
                        AutomationException

Indicates if labels are placed parallel to lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPerpendicular

boolean isPerpendicular()
                        throws IOException,
                               AutomationException

Indicates if labels are placed perpendicular to lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPerpendicular

void setPerpendicular(boolean flag)
                      throws IOException,
                             AutomationException

Indicates if labels are placed perpendicular to lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isHorizontal

boolean isHorizontal()
                     throws IOException,
                            AutomationException

Indicates if labels are placed horizontally.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontal

void setHorizontal(boolean flag)
                   throws IOException,
                          AutomationException

Indicates if labels are placed horizontally.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flag - The flag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffset

double getOffset()
                 throws IOException,
                        AutomationException

Offset from the start/end of lines (in map units).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The offset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffset

void setOffset(double offset)
               throws IOException,
                      AutomationException

Offset from the start/end of lines (in map units).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

offset - The offset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.