ESRI.ArcGIS.ADF.IMS
LabelPriority Class
Members  See Also  Send Feedback
ESRI.ArcGIS.ADF.IMS.Display.Renderer Namespace : LabelPriority Class




An object that represents how a Label is placed in reference to the point.

Object Model

LabelPriority Class

Syntax

Visual Basic (Declaration) 
<SerializableAttribute()>
Public Class LabelPriority 
Visual Basic (Usage)Copy Code
Dim instance As LabelPriority
C# 
[SerializableAttribute()]
public class LabelPriority 

Example

See class constructors for examples of using LabelPriorities.

Remarks

LabelPriority accepts different weights for each of eight positions around a point. Each position corresponds to the positions as shown below:

1 (UpperLeft) 2 (Upper) 3 (UpperRight)
8 (Left) x 4 (Right)
7 (LowerLeft) 6 (Lower) 5 (LowerRight)

In each position, you can prioritize the importance of that position from 0 upwards. 0 signifies that the label should not be placed in that position. 1 means that this is an acceptable position for the label, and all higher numbers represent lesser priorities for that position. For example, "1,0,1,0,0,0,0,0" means that only the first and third label positions will be taken into account when labeling. In another example, "1,2,3,0,1,0,0,0" means try to label at the first and fifth position; if not, then put the label at the second position; if not, then put it at the third position; if this is not possible, then don't label it.

You can set LabelPriority in two ways:

  • Use the default constructor and set integer values for each label position using LabelPriority's properties.

or

  • Use the constructor that accepts a string of comma-delimited priority values corresponding to the eight positions, as shown in the above paragraph.

The default priority sequence is 2,2,1,4,5,3,2,4.

If all eight property values are set to 0, then labels will be placed directly on top of the point. This is equivalent to calling SetPriority_LEPlaceOnTopHorizontal.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2011 All Rights Reserved.