com.esri.arcgis.carto
Interface ILineLabelPlacementPriorities

All Superinterfaces:
Serializable
All Known Implementing Classes:
LineLabelPlacementPriorities

public interface ILineLabelPlacementPriorities
extends Serializable

Provides access to members that control placement position priorities for line labels.

Description

The properties of this interface correspond to the settings on the label start point and end point priorities dialogs in ArcMap. These properties are also used for feature-linked annotation.

Remarks

Not all properties of this interface are used when labeling in ArcMap. Whether or not properties are used depends on settings on ILineLabelPosition.

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. These rules are also described here:

  1. ILineLabelPosition::Above and ILineLabelPosition::Left determine whether or not the properties that begin with "Above" on this object are used. If either of these are True, then these properties are used.
  2. ILineLabelPosition::OnTop determines whether or not the properties that begin with "Center" on this object are used. If this is True, then these properties are used.
  3. ILineLabelPosition::Below and ILineLabelPosition::Right determine whether or not the properties that begin with "Below" on this object are used. If either of these are True, then these properties are used.

When To Use

The ILineLabelPlacementPriorities interface maintains information about the placement alternatives of labels relative to line features. For example, use this interface to specify whether labels can be placed above, below or centered on lines.

Each available position is assigned a weight between 0-9. Zero (0) means that this position is not to be considered at all (blocked), whereas a position assigned the weight one (1) would be tried before two (2) and so on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IBasicOverposterLayerProperties

Method Summary
 int getAboveAfter()
          Label position priority for above and after the line.
 int getAboveAlong()
          Label position priority for above and along the line.
 int getAboveBefore()
          Label position priority for above and before the line.
 int getAboveEnd()
          Label position priority for above and at the end of the line.
 int getAboveStart()
          Label position priority for above and at the start of the line.
 int getBelowAfter()
          Label position priority for below and after the line.
 int getBelowAlong()
          Label position priority for below and along the line.
 int getBelowBefore()
          Label position priority for below and before the line.
 int getBelowEnd()
          Label position priority for below and at the end of the line.
 int getBelowStart()
          Label position priority for below and at the start of the line.
 int getCenterAfter()
          Label position priority for in the center and after the line.
 int getCenterAlong()
          Label position priority for in the center and along the line.
 int getCenterBefore()
          Label position priority for in the center and before the line.
 int getCenterEnd()
          Label position priority for in the center and at the end of the line.
 int getCenterStart()
          Label position priority for in the center and at the start of the line.
 void setAboveAfter(int priority)
          Label position priority for above and after the line.
 void setAboveAlong(int priority)
          Label position priority for above and along the line.
 void setAboveBefore(int priority)
          Label position priority for above and before the line.
 void setAboveEnd(int priority)
          Label position priority for above and at the end of the line.
 void setAboveStart(int priority)
          Label position priority for above and at the start of the line.
 void setBelowAfter(int priority)
          Label position priority for below and after the line.
 void setBelowAlong(int priority)
          Label position priority for below and along the line.
 void setBelowBefore(int priority)
          Label position priority for below and before the line.
 void setBelowEnd(int priority)
          Label position priority for below and at the end of the line.
 void setBelowStart(int priority)
          Label position priority for below and at the start of the line.
 void setCenterAfter(int priority)
          Label position priority for in the center and after the line.
 void setCenterAlong(int priority)
          Label position priority for in the center and along the line.
 void setCenterBefore(int priority)
          Label position priority for in the center and before the line.
 void setCenterEnd(int priority)
          Label position priority for in the center and at the end of the line.
 void setCenterStart(int priority)
          Label position priority for in the center and at the start of the line.
 

Method Detail

getAboveBefore

int getAboveBefore()
                   throws IOException,
                          AutomationException
Label position priority for above and before the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAboveBefore

void setAboveBefore(int priority)
                    throws IOException,
                           AutomationException
Label position priority for above and before the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAboveStart

int getAboveStart()
                  throws IOException,
                         AutomationException
Label position priority for above and at the start of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAboveStart

void setAboveStart(int priority)
                   throws IOException,
                          AutomationException
Label position priority for above and at the start of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAboveAlong

int getAboveAlong()
                  throws IOException,
                         AutomationException
Label position priority for above and along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAboveAlong

void setAboveAlong(int priority)
                   throws IOException,
                          AutomationException
Label position priority for above and along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAboveEnd

int getAboveEnd()
                throws IOException,
                       AutomationException
Label position priority for above and at the end of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAboveEnd

void setAboveEnd(int priority)
                 throws IOException,
                        AutomationException
Label position priority for above and at the end of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAboveAfter

int getAboveAfter()
                  throws IOException,
                         AutomationException
Label position priority for above and after the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAboveAfter

void setAboveAfter(int priority)
                   throws IOException,
                          AutomationException
Label position priority for above and after the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCenterBefore

int getCenterBefore()
                    throws IOException,
                           AutomationException
Label position priority for in the center and before the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCenterBefore

void setCenterBefore(int priority)
                     throws IOException,
                            AutomationException
Label position priority for in the center and before the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCenterStart

int getCenterStart()
                   throws IOException,
                          AutomationException
Label position priority for in the center and at the start of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCenterStart

void setCenterStart(int priority)
                    throws IOException,
                           AutomationException
Label position priority for in the center and at the start of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCenterAlong

int getCenterAlong()
                   throws IOException,
                          AutomationException
Label position priority for in the center and along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCenterAlong

void setCenterAlong(int priority)
                    throws IOException,
                           AutomationException
Label position priority for in the center and along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCenterEnd

int getCenterEnd()
                 throws IOException,
                        AutomationException
Label position priority for in the center and at the end of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCenterEnd

void setCenterEnd(int priority)
                  throws IOException,
                         AutomationException
Label position priority for in the center and at the end of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCenterAfter

int getCenterAfter()
                   throws IOException,
                          AutomationException
Label position priority for in the center and after the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCenterAfter

void setCenterAfter(int priority)
                    throws IOException,
                           AutomationException
Label position priority for in the center and after the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBelowBefore

int getBelowBefore()
                   throws IOException,
                          AutomationException
Label position priority for below and before the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBelowBefore

void setBelowBefore(int priority)
                    throws IOException,
                           AutomationException
Label position priority for below and before the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBelowStart

int getBelowStart()
                  throws IOException,
                         AutomationException
Label position priority for below and at the start of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBelowStart

void setBelowStart(int priority)
                   throws IOException,
                          AutomationException
Label position priority for below and at the start of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBelowAlong

int getBelowAlong()
                  throws IOException,
                         AutomationException
Label position priority for below and along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBelowAlong

void setBelowAlong(int priority)
                   throws IOException,
                          AutomationException
Label position priority for below and along the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBelowEnd

int getBelowEnd()
                throws IOException,
                       AutomationException
Label position priority for below and at the end of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBelowEnd

void setBelowEnd(int priority)
                 throws IOException,
                        AutomationException
Label position priority for below and at the end of the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBelowAfter

int getBelowAfter()
                  throws IOException,
                         AutomationException
Label position priority for below and after the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBelowAfter

void setBelowAfter(int priority)
                   throws IOException,
                          AutomationException
Label position priority for below and after the line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.