IOverposter Interface

Provides access to members that place labels for features using conflict detection. Note: the IOverposter interface has been superseded by IOverposter3. Please consider using the more recent version.

Product Availability

Description

IOverposter is an interface for placing labels and symbols implemented by BasicOveposter (aka the ESRI Standard Label Engine).  Follow this general sequence of steps when using this interface:

1. Call AddClass for each class to initialize properties for each class.  (InsertClass, RemoveClass, and ResetClasses help manage the classes.)
2. Use Initialize to set up the current extent and display.
3. Call AddBarrier, AddLabel, and/or AddSymbol for each participating feature.
4. Call PlaceObjects to make sure all objects are placed.
5. Use NextPlaced, NextUnplaced, and/or NextUnused to get placed object locations.  You will probably want to draw them as you get them.
6. Call ReleaseResources.

This interface is designed for low level access to the placement algorithms of the BasicOverposter.  The labeling maps and features, use the AnnotateMap and AnnoateFeature objects.  They wrap calls to the BasicOverposter into a more general form for use with layers and maps.

When To Use

The IOverposter interface is a low level interface for managing conflict detection when labeling features.

Members

	Name	Description
	AddBarriers	Adds a barrier object that placed objects must avoid.
	AddClass	Adds a class to the overposter and specifies its properties.
	AddCurvedLabel	Adds a curved label object to be placed.
	AddLabel	Adds a label object to be placed.
	AddSymbol	Adds a symbol to be placed.
	Capabilities	Overposter capabilities for the specified layer.
	Initialize	Initializes the overposter for drawing into the specified area of the map display.
	InsertClass	Inserts a class at a specific index, and specifies its peoperties.
	NextPlaced	The next object that was successfully placed.
	NextUnplaced	The next object that was not successfully placed.
	NextUnused	The next object that was not used.
	NumberOfPlacedLabels	The number of unplaced labels. Only valid after calling PlaceObjects.
	NumberOfUnplacedLabels	The number of unplaced labels. Only valid after calling PlaceObjects.
	NumClasses	The number of classes.
	PlaceObjects	Places objects using the overposter.
	ReleaseResources	Releases current objects from memory.
	RemoveClass	Removes the class at the specified index from the overposter.
	ResetClasses	Removes all classes from the overposter.

Classes that implement IOverposter