|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IAnnotateLayerProperties
Provides access to members that work with the display of dynamic labels (text) for a feature layer.
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.
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.
Method Summary | |
---|---|
String |
esri_getClass()
The class name. |
double |
getAnnotationMaximumScale()
The maximum scale at which to display annotation. |
double |
getAnnotationMinimumScale()
The minimum scale at which to display annotation. |
IEnvelope |
getExtent()
The extent to perform labeling in. |
IFeatureLayer |
getFeatureLayer()
The annotated feature class. |
IGraphicsContainer |
getGraphicsContainer()
The output graphics container for placed labels. |
int |
getLabelWhichFeatures()
The type of features labeled. |
int |
getPriority()
Priority for labels of this feature class (0 is highest). |
String |
getWhereClause()
SQL where clause that determines which features are labeled. |
boolean |
isAddUnplacedToGraphicsContainer()
Indicates if overflow labels are put into a graphics container. |
boolean |
isCreateUnplacedElements()
Indicates if unplaced elements are created. |
boolean |
isDisplayAnnotation()
Indicates if the layer displays annotation. |
boolean |
isFeatureLinked()
Indicates if the text is feature linked. |
boolean |
isUseOutput()
Indicates if the output will be used. |
void |
setAddUnplacedToGraphicsContainer(boolean value)
Indicates if overflow labels are put into a graphics container. |
void |
setAnnotationMaximumScale(double maxScale)
The maximum scale at which to display annotation. |
void |
setAnnotationMinimumScale(double minScale)
The minimum scale at which to display annotation. |
void |
setClass(String className)
The class name. |
void |
setCreateUnplacedElements(boolean flag)
Indicates if unplaced elements are created. |
void |
setDisplayAnnotation(boolean value)
Indicates if the layer displays annotation. |
void |
setExtent(IEnvelope extent)
The extent to perform labeling in. |
void |
setFeatureLayerByRef(IFeatureLayer featureLayer)
The annotated feature class. |
void |
setFeatureLinked(boolean flag)
Indicates if the text is feature linked. |
void |
setGraphicsContainerByRef(IGraphicsContainer graphicsContainer)
The output graphics container for placed labels. |
void |
setLabelWhichFeatures(int type)
The type of features labeled. |
void |
setPriority(int priority)
Priority for labels of this feature class (0 is highest). |
void |
setUseOutput(boolean set)
Indicates if the output will be used. |
void |
setWhereClause(String whereClause)
SQL where clause that determines which features are labeled. |
Method Detail |
---|
void setUseOutput(boolean set) throws IOException, AutomationException
set
- The set (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isUseOutput() throws IOException, AutomationException
This is useful when converting labels to graphics and some layers will not be creating graphics while they are still fed to the label engine to produce correct placement.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope getExtent() throws IOException, AutomationException
Extent is the extent (IEnvelope ) that is used when LabelWhichFeatures is used.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setExtent(IEnvelope extent) throws IOException, AutomationException
extent
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IFeatureLayer getFeatureLayer() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setFeatureLayerByRef(IFeatureLayer featureLayer) throws IOException, AutomationException
featureLayer
- A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setClass(String className) throws IOException, AutomationException
className
- The className (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String esri_getClass() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setLabelWhichFeatures(int type) throws IOException, AutomationException
type
- A com.esri.arcgis.carto.esriLabelWhichFeatures constant (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getLabelWhichFeatures() throws IOException, AutomationException
LabelWhichFeatures specifies which features to label (all, selected or visible).
This is useful when converting labels to graphics.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setCreateUnplacedElements(boolean flag) throws IOException, AutomationException
flag
- The flag (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isCreateUnplacedElements() throws IOException, AutomationException
CreateUnplacedElements specifies whether or not unplaced elements will be created.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getAnnotationMinimumScale() throws IOException, AutomationException
AnnotationMinimumScale is the minimum scale at which labels will be drawn.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setAnnotationMinimumScale(double minScale) throws IOException, AutomationException
minScale
- The minScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getAnnotationMaximumScale() throws IOException, AutomationException
AnnotationMaximumScale is the maximum scale at which labels will be drawn.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setAnnotationMaximumScale(double maxScale) throws IOException, AutomationException
maxScale
- The maxScale (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setFeatureLinked(boolean flag) throws IOException, AutomationException
flag
- The flag (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isFeatureLinked() throws IOException, AutomationException
FeatureLinked FeatureLinked specifies whether or not labels will be created with a link to the feature attributes.
This is useful when converting labels to annotation.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setPriority(int priority) throws IOException, AutomationException
priority
- The priority (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.int getPriority() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isDisplayAnnotation() throws IOException, AutomationException
DisplayAnnotation specifies whether or not the labels in this set will be displayed.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setDisplayAnnotation(boolean value) throws IOException, AutomationException
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setWhereClause(String whereClause) throws IOException, AutomationException
whereClause
- The whereClause (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.String getWhereClause() throws IOException, AutomationException
WhereClause is an SQL statement that determines which features are to be labeled.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setGraphicsContainerByRef(IGraphicsContainer graphicsContainer) throws IOException, AutomationException
graphicsContainer
- A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IGraphicsContainer getGraphicsContainer() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.boolean isAddUnplacedToGraphicsContainer() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setAddUnplacedToGraphicsContainer(boolean value) throws IOException, AutomationException
value
- The value (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |