ArcObjects Library Reference (Carto)  

ILineLabelPlacementPriorities Interface

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

Product Availability

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

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.

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.

Members

Description
Read/write property AboveAfter Label position priority for above and after the line.
Read/write property AboveAlong Label position priority for above and along the line.
Read/write property AboveBefore Label position priority for above and before the line.
Read/write property AboveEnd Label position priority for above and at the end of the line.
Read/write property AboveStart Label position priority for above and at the start of the line.
Read/write property BelowAfter Label position priority for below and after the line.
Read/write property BelowAlong Label position priority for below and along the line.
Read/write property BelowBefore Label position priority for below and before the line.
Read/write property BelowEnd Label position priority for below and at the end of the line.
Read/write property BelowStart Label position priority for below and at the start of the line.
Read/write property CenterAfter Label position priority for in the center and after the line.
Read/write property CenterAlong Label position priority for in the center and along the line.
Read/write property CenterBefore Label position priority for in the center and before the line.
Read/write property CenterEnd Label position priority for in the center and at the end of the line.
Read/write property CenterStart Label position priority for in the center and at the start of the line.

CoClasses that implement ILineLabelPlacementPriorities

CoClasses and Classes Description
LineLabelPlacementPriorities Controls placement position priorities for line labels.

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.

See Also

IBasicOverposterLayerProperties Interface