IAnnotateLayerProperties Interface

Provides access to members that work with the display of dynamic labels (text) for a feature layer.

Product Availability

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

When To Use

The IAnnotateLayerProperties interface maintains the labeling properties for a feature layer. You can use this interface to define the display of dynamic labels (text) along features.

Members

		Description
	AddUnplacedToGraphicsContainer	Indicates if overflow labels are put into a graphics container.
	AnnotationMaximumScale	The maximum scale at which to display annotation.
	AnnotationMinimumScale	The minimum scale at which to display annotation.
	Class	The class name.
	CreateUnplacedElements	Indicates if unplaced elements are created.
	DisplayAnnotation	Indicates if the layer displays annotation.
	Extent	The extent to perform labeling in.
	FeatureLayer	The annotated feature class.
	FeatureLinked	Indicates if the text is feature linked.
	GraphicsContainer	The output graphics container for placed labels.
	LabelWhichFeatures	The type of features labeled.
	Priority	Priority for labels of this feature class (0 is highest).
	UseOutput	Indicates if the output will be used.
	WhereClause	SQL where clause that determines which features are labeled.

CoClasses that implement IAnnotateLayerProperties

CoClasses and Classes	Description
LabelEngineLayerProperties	A container for the properties of feature labels.
LabelEngineSurveyLayerProps (esriSurveyExt)	LabelEngineSurveyLayerProps Class
MaplexLabelEngineLayerProperties	Properties that specify the labeling of a layer and conversion of labels to annotation.

Remarks

Each FeatureLayer can have one or more LabelEngineLayerProperties associated with it. These are exposed in the ArcMap user interface as label classes and a reference to these properties can be obtained from the IAnnotateLayerPropertiesCollection interface. IAnnotateLayerProperties is used to access and modify the labeling properties of a label class of a FeatureLayer.

[Visual Basic 6.0]

The following VB example is a code excerpt that shows how to get a reference to an IAnnotateLayerProperties interface with Visual Basic.

'This example assumes that you already have an IFeatureClass (fC) set to a valid feature class.

  Dim fL As IFeatureLayer

  Set fL = New FeatureLayer

  Set fL.FeatureClass = fC



  'get AnnotateLayerPropertiesCollection from GeoFeatureLayer

  Dim pGeoFL As IGeoFeatureLayer

  Set pGeoFL = fL  'QI (Query Interface)

  Dim pAnnoLayerPropsColl As IAnnotateLayerPropertiesCollection

  Set pAnnoLayerPropsColl = pGeoFL.AnnotationProperties



  'get the (first) AnnotateLayerProperties property set in the collection

  Dim pAnnoLayerProps As IAnnotateLayerProperties

  pAnnoLayerPropsColl.QueryItem 0, pAnnoLayerProps, Nothing, Nothing



  MsgBox pAnnoLayerProps.DisplayAnnotation

Send feedback on this page