ArcObjects Library Reference (Carto)  

IBasicOverposterLayerProperties4 Interface

Provides access to members that control the placement of labels relative to features using conflict detection.

Product Availability

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

Description

Manages settings that control the placement of dynamic labels and feature-linked annotation relative to features. This interface manages generic settings that apply to all feature geometry types (point, line, and polygon). This interface also manages, or provides access to other objects that manage, placement properties that are used only when labeling or annotating a specific feature geometry type.

Members

Description
Read/write property BufferRatio Label buffer ratio. A value of 1 means a buffer the size of the label height.
Read/write property FeatureType Feature type.
Read/write property FeatureWeight Barrier weighting for features in the layer.
Read/write property GenerateUnplacedLabels Indicates if unplaced labels are generated.
Read/write property LabelWeight Barrier weighting for labels in the layer.
Read/write property LineLabelPlacementPriorities Line label placement position priority options.
Read/write property LineLabelPosition Line label placement position options.
Read/write property LineOffset Offset in map units at which labels will be placed away from line features.
Read/write property MaxDistanceFromTarget Maximum distance in map units the label is allowed to be away from the feature.
Read/write property NumLabelsOption Feature labeling option for the layer.
Read/write property PerpendicularToAngle Indicates whether the label should be drawn perpendicular to the angle.
Read/write property PlaceOnlyInsidePolygon Indicates whether label is to be placed only within the polygon.
Read/write property PointPlacementAngles Point label placement angle(s).
Read/write property PointPlacementMethod Point label placement method.
Read/write property PointPlacementOnTop Indicates if point labels are placed on top of features.
Read/write property PointPlacementPriorities Point label placement position priority options.
Read/write property PolygonPlacementMethod Polygon label placement method.
Read/write property RotationField The attribute field that contains the label angle.
Read/write property RotationType Defines the format is the rotation field in.

CoClasses that implement IBasicOverposterLayerProperties4

CoClasses and Classes Description
BasicOverposterLayerProperties Controls the placement of labels or symbols relative to features using conflict detection.

Remarks

Not all property value combinations on this interface 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 and this object will not correct any of 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. A few guidelines are provided here:

The following members are used only when labeling or annotating point features: PerpendicularToAngle, PointPlacementAngles, PointPlacementMethod, PointPlacementOnTop, and PointPlacementPriorities, RotationField, and RotationType . Note that labels can be placed at an angle, or on top of point features, but not both.

The following members are used only when labeling or annotating line features: LineLabelPlacementPriorities, LineLabelPosition, and LineOffset. Read the help for ILineLabelPlacementProperties and ILineLabelPosition to learn more about line label placement properties.

The following members are used only when labeling or annotating polygon features: PlaceOnlyInsidePolygon and PolygonPlacementMethod .

MaxDistanceFromTarget is used only when the label engine is used to place chart symbols.

The property GenerateUnplacedLabels simply determines whether unplaced labels are generated by the label engine or not.  To specify whether or not to display the unplaced labels, see the property IOverposterLayerProperties2::TagUnplaced

See Also

ILabelEngineLayerProperties Interface