com.esri.arcgis.carto
Class MaplexLabelEngineLayerProperties

java.lang.Object
  extended by com.esri.arcgis.carto.MaplexLabelEngineLayerProperties
All Implemented Interfaces:
IAnnotateLayerProperties, IAnnotateLayerTransformationProperties, IAnnotateProperties, ILabelEngineLayerProperties, ILabelEngineLayerProperties2, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class MaplexLabelEngineLayerProperties
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IAnnotateProperties, IAnnotateLayerProperties, ILabelEngineLayerProperties, ILabelEngineLayerProperties2, IAnnotateLayerTransformationProperties, IPersistStream, IClone, Externalizable

Properties that specify the labeling of a layer and conversion of labels to annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
MaplexLabelEngineLayerProperties()
          Constructs a MaplexLabelEngineLayerProperties using ArcGIS Engine.
MaplexLabelEngineLayerProperties(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexLabelEngineLayerProperties theMaplexLabelEngineLayerProperties = (MaplexLabelEngineLayerProperties) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 String esri_getClass()
          The class name.
 int getAnnotationClassID()
          The ID of the annotation class.
 double getAnnotationMaximumScale()
          The maximum scale at which to display annotation.
 double getAnnotationMinimumScale()
          The minimum scale at which to display annotation.
 IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
          The overposter properties, which specify how labels are placed relative to features.
 IEnvelope getBounds()
          The full extent in world coordinates.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 String getExpression()
          The VBScript or JScript expression that evaluates and formats the label.
 IAnnotationExpressionEngine getExpressionParser()
          The object that interprets the expression.
 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.
 double getOffset()
          The offset between the label and the feature.
 IOverposterLayerProperties getOverposterLayerProperties()
          The overposter properties, which specify how labels are placed relative to features.
 int getPriority()
          Priority for labels of this feature class (0 is highest).
 double getReferenceScale()
          Reference scale for computing scaled symbol sizes.
 double getScaleRatio()
          Scale ratio of the transformation.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 ITextSymbol getSymbol()
          The text symbol used to draw the label.
 int getSymbolID()
          The ID of the group symbol used to draw the label.
 int getUnits()
          The units of the world coordinates.
 String getWhereClause()
          SQL where clause that determines which features are labeled.
 int hashCode()
          the hashcode for this object
 boolean isAddUnplacedToGraphicsContainer()
          Indicates if overflow labels are put into a graphics container.
 boolean isCreateUnplacedElements()
          Indicates if unplaced elements are created.
 void isDirty()
          isDirty
 boolean isDisplayAnnotation()
          Indicates if the layer displays annotation.
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isExpressionSimple()
          Indicates if the expression is simple.
 boolean isFeatureLinked()
          Indicates if the text is feature linked.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isUseOutput()
          Indicates if the output will be used.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setAddUnplacedToGraphicsContainer(boolean value)
          Indicates if overflow labels are put into a graphics container.
 void setAnnotationClassID(int annotationClassID)
          The ID of the annotation class.
 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 setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
          The overposter properties, which specify how labels are placed relative to features.
 void setBounds(IEnvelope bounds)
          The full extent in world coordinates.
 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 setExpression(String expression)
          The VBScript or JScript expression that evaluates and formats the label.
 void setExpressionParserByRef(IAnnotationExpressionEngine engine)
          The object that interprets the expression.
 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 setIsExpressionSimple(boolean simpleExpression)
          Indicates if the expression is simple.
 void setLabelWhichFeatures(int type)
          The type of features labeled.
 void setOffset(double offset)
          The offset between the label and the feature.
 void setOverposterLayerPropertiesByRef(IOverposterLayerProperties props)
          The overposter properties, which specify how labels are placed relative to features.
 void setPriority(int priority)
          Priority for labels of this feature class (0 is highest).
 void setReferenceScale(double scale)
          Reference scale for computing scaled symbol sizes.
 void setScaleRatio(double scale)
          Scale ratio of the transformation.
 void setSymbolByRef(ITextSymbol textSymbol)
          The text symbol used to draw the label.
 void setSymbolID(int pSymbolID)
          The ID of the group symbol used to draw the label.
 void setUnits(int unitsCode)
          The units of the world coordinates.
 void setUseOutput(boolean set)
          Indicates if the output will be used.
 void setWhereClause(String whereClause)
          SQL where clause that determines which features are labeled.
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

MaplexLabelEngineLayerProperties

public MaplexLabelEngineLayerProperties()
                                 throws IOException,
                                        UnknownHostException
Constructs a MaplexLabelEngineLayerProperties using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

MaplexLabelEngineLayerProperties

public MaplexLabelEngineLayerProperties(Object obj)
                                 throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
MaplexLabelEngineLayerProperties theMaplexLabelEngineLayerProperties = (MaplexLabelEngineLayerProperties) obj;

Construct a MaplexLabelEngineLayerProperties using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to MaplexLabelEngineLayerProperties.

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

setUseOutput

public void setUseOutput(boolean set)
                  throws IOException,
                         AutomationException
Indicates if the output will be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUseOutput in interface IAnnotateLayerProperties
Parameters:
set - The set (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseOutput

public boolean isUseOutput()
                    throws IOException,
                           AutomationException
Indicates if the output will be used.

Description

UseOutput specifies whether or not to produce elements.

Remarks

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUseOutput in interface IAnnotateLayerProperties
Returns:
The set
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtent

public IEnvelope getExtent()
                    throws IOException,
                           AutomationException
The extent to perform labeling in.

Description

Extent is the extent (IEnvelope ) that is used when LabelWhichFeatures is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtent in interface IAnnotateLayerProperties
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtent

public void setExtent(IEnvelope extent)
               throws IOException,
                      AutomationException
The extent to perform labeling in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setExtent in interface IAnnotateLayerProperties
Parameters:
extent - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureLayer

public IFeatureLayer getFeatureLayer()
                              throws IOException,
                                     AutomationException
The annotated feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getFeatureLayer in interface IAnnotateLayerProperties
Returns:
A reference to a com.esri.arcgis.carto.IFeatureLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureLayerByRef

public void setFeatureLayerByRef(IFeatureLayer featureLayer)
                          throws IOException,
                                 AutomationException
The annotated feature class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFeatureLayerByRef in interface IAnnotateLayerProperties
Parameters:
featureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClass

public void setClass(String className)
              throws IOException,
                     AutomationException
The class name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setClass in interface IAnnotateLayerProperties
Parameters:
className - The className (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_getClass

public String esri_getClass()
                     throws IOException,
                            AutomationException
The class name.

Product Availability

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

Specified by:
esri_getClass in interface IAnnotateLayerProperties
Returns:
The className
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelWhichFeatures

public void setLabelWhichFeatures(int type)
                           throws IOException,
                                  AutomationException
The type of features labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setLabelWhichFeatures in interface IAnnotateLayerProperties
Parameters:
type - A com.esri.arcgis.carto.esriLabelWhichFeatures constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelWhichFeatures

public int getLabelWhichFeatures()
                          throws IOException,
                                 AutomationException
The type of features labeled.

Description

LabelWhichFeatures specifies which features to label (all, selected or visible).

Remarks

This is useful when converting labels to graphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLabelWhichFeatures in interface IAnnotateLayerProperties
Returns:
A com.esri.arcgis.carto.esriLabelWhichFeatures constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCreateUnplacedElements

public void setCreateUnplacedElements(boolean flag)
                               throws IOException,
                                      AutomationException
Indicates if unplaced elements are created.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCreateUnplacedElements in interface IAnnotateLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCreateUnplacedElements

public boolean isCreateUnplacedElements()
                                 throws IOException,
                                        AutomationException
Indicates if unplaced elements are created.

Description

CreateUnplacedElements specifies whether or not unplaced elements will be created.

Remarks

Unplaced elements are labels who don't fit without overlapping each other. This is useful when converting labels to graphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isCreateUnplacedElements in interface IAnnotateLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationMinimumScale

public double getAnnotationMinimumScale()
                                 throws IOException,
                                        AutomationException
The minimum scale at which to display annotation.

Description

AnnotationMinimumScale is the minimum scale at which labels will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAnnotationMinimumScale in interface IAnnotateLayerProperties
Returns:
The minScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnnotationMinimumScale

public void setAnnotationMinimumScale(double minScale)
                               throws IOException,
                                      AutomationException
The minimum scale at which to display annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAnnotationMinimumScale in interface IAnnotateLayerProperties
Parameters:
minScale - The minScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationMaximumScale

public double getAnnotationMaximumScale()
                                 throws IOException,
                                        AutomationException
The maximum scale at which to display annotation.

Description

AnnotationMaximumScale is the maximum scale at which labels will be drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAnnotationMaximumScale in interface IAnnotateLayerProperties
Returns:
The maxScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnnotationMaximumScale

public void setAnnotationMaximumScale(double maxScale)
                               throws IOException,
                                      AutomationException
The maximum scale at which to display annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAnnotationMaximumScale in interface IAnnotateLayerProperties
Parameters:
maxScale - The maxScale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFeatureLinked

public void setFeatureLinked(boolean flag)
                      throws IOException,
                             AutomationException
Indicates if the text is feature linked.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFeatureLinked in interface IAnnotateLayerProperties
Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFeatureLinked

public boolean isFeatureLinked()
                        throws IOException,
                               AutomationException
Indicates if the text is feature linked.

Description

FeatureLinked FeatureLinked specifies whether or not labels will be created with a link to the feature attributes.

Remarks

This is useful when converting labels to annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isFeatureLinked in interface IAnnotateLayerProperties
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriority

public void setPriority(int priority)
                 throws IOException,
                        AutomationException
Priority for labels of this feature class (0 is highest).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPriority in interface IAnnotateLayerProperties
Parameters:
priority - The priority (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

public int getPriority()
                throws IOException,
                       AutomationException
Priority for labels of this feature class (0 is highest).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPriority in interface IAnnotateLayerProperties
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDisplayAnnotation

public boolean isDisplayAnnotation()
                            throws IOException,
                                   AutomationException
Indicates if the layer displays annotation.

Description

DisplayAnnotation specifies whether or not the labels in this set will be displayed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDisplayAnnotation in interface IAnnotateLayerProperties
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayAnnotation

public void setDisplayAnnotation(boolean value)
                          throws IOException,
                                 AutomationException
Indicates if the layer displays annotation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayAnnotation in interface IAnnotateLayerProperties
Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException
SQL where clause that determines which features are labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setWhereClause in interface IAnnotateLayerProperties
Parameters:
whereClause - The whereClause (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWhereClause

public String getWhereClause()
                      throws IOException,
                             AutomationException
SQL where clause that determines which features are labeled.

Description

WhereClause is an SQL statement that determines which features are to be labeled.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getWhereClause in interface IAnnotateLayerProperties
Returns:
The whereClause
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGraphicsContainerByRef

public void setGraphicsContainerByRef(IGraphicsContainer graphicsContainer)
                               throws IOException,
                                      AutomationException
The output graphics container for placed labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setGraphicsContainerByRef in interface IAnnotateLayerProperties
Parameters:
graphicsContainer - A reference to a com.esri.arcgis.carto.IGraphicsContainer (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGraphicsContainer

public IGraphicsContainer getGraphicsContainer()
                                        throws IOException,
                                               AutomationException
The output graphics container for placed labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getGraphicsContainer in interface IAnnotateLayerProperties
Returns:
A reference to a com.esri.arcgis.carto.IGraphicsContainer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAddUnplacedToGraphicsContainer

public boolean isAddUnplacedToGraphicsContainer()
                                         throws IOException,
                                                AutomationException
Indicates if overflow labels are put into a graphics container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isAddUnplacedToGraphicsContainer in interface IAnnotateLayerProperties
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAddUnplacedToGraphicsContainer

public void setAddUnplacedToGraphicsContainer(boolean value)
                                       throws IOException,
                                              AutomationException
Indicates if overflow labels are put into a graphics container.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAddUnplacedToGraphicsContainer in interface IAnnotateLayerProperties
Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolByRef

public void setSymbolByRef(ITextSymbol textSymbol)
                    throws IOException,
                           AutomationException
The text symbol used to draw the label.

Product Availability

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

Specified by:
setSymbolByRef in interface ILabelEngineLayerProperties
Specified by:
setSymbolByRef in interface ILabelEngineLayerProperties2
Parameters:
textSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbol

public ITextSymbol getSymbol()
                      throws IOException,
                             AutomationException
The text symbol used to draw the label.

Description

Symbol is the TextSymbol to be used for labeling.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSymbol in interface ILabelEngineLayerProperties
Specified by:
getSymbol in interface ILabelEngineLayerProperties2
Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolID

public void setSymbolID(int pSymbolID)
                 throws IOException,
                        AutomationException
The ID of the group symbol used to draw the label.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setSymbolID in interface ILabelEngineLayerProperties
Specified by:
setSymbolID in interface ILabelEngineLayerProperties2
Parameters:
pSymbolID - The pSymbolID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbolID

public int getSymbolID()
                throws IOException,
                       AutomationException
The ID of the group symbol used to draw the label.

Description

SymbolID is the ID of the group symbol used for labeling.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSymbolID in interface ILabelEngineLayerProperties
Specified by:
getSymbolID in interface ILabelEngineLayerProperties2
Returns:
The pSymbolID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOffset

public void setOffset(double offset)
               throws IOException,
                      AutomationException
The offset between the label and the feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setOffset in interface ILabelEngineLayerProperties
Specified by:
setOffset in interface ILabelEngineLayerProperties2
Parameters:
offset - The offset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOffset

public double getOffset()
                 throws IOException,
                        AutomationException
The offset between the label and the feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOffset in interface ILabelEngineLayerProperties
Specified by:
getOffset in interface ILabelEngineLayerProperties2
Returns:
The offset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBasicOverposterLayerPropertiesByRef

public void setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
                                            throws IOException,
                                                   AutomationException
The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Specified by:
setBasicOverposterLayerPropertiesByRef in interface ILabelEngineLayerProperties
Specified by:
setBasicOverposterLayerPropertiesByRef in interface ILabelEngineLayerProperties2
Parameters:
props - A reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBasicOverposterLayerProperties

public IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
                                                                  throws IOException,
                                                                         AutomationException
The overposter properties, which specify how labels are placed relative to features.

Description

BasicOverposterLayerProperties is the placement properties.

Remarks

Use this to specify how labels will be placed relative to features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBasicOverposterLayerProperties in interface ILabelEngineLayerProperties
Specified by:
getBasicOverposterLayerProperties in interface ILabelEngineLayerProperties2
Returns:
A reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpression

public void setExpression(String expression)
                   throws IOException,
                          AutomationException
The VBScript or JScript expression that evaluates and formats the label.

Example:

//SIMPLE EXPRESSION 
pLabelEngineLayerProps.setExpressionSimple(true); 
pLabelEngineLayerProps.setExpression("Ucase([Name]));
 
//ADVANCED EXPRESSION 
pLabelEngineLayerProps.setExpressionSimple(false);
 
//set the .Expression property = the entire function 
codepLabelEngineLayerProps.setExpression("Function FindLabel ([Name],[Area]) if [Area] > 1500 then FindLabel = UCase([Name]) else FindLabel = lcase([Name]) end if end function");

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setExpression in interface ILabelEngineLayerProperties
Specified by:
setExpression in interface ILabelEngineLayerProperties2
Parameters:
expression - The expression (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExpression

public String getExpression()
                     throws IOException,
                            AutomationException
The VBScript or JScript expression that evaluates and formats the label.

Description

Expression is the expression that evaluates and formats the label (text). This can be a simple as a single field name enclosed in brackets or as complex as a script written in the language specified by the ExpressionParser. If the expression is a script it must contain a function call FindLabel and the IsExpressionSimple property should be set to FALSE.

Remarks

This can be based on either VBScript or JavaScript.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExpression in interface ILabelEngineLayerProperties
Specified by:
getExpression in interface ILabelEngineLayerProperties2
Returns:
The expression
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsExpressionSimple

public void setIsExpressionSimple(boolean simpleExpression)
                           throws IOException,
                                  AutomationException
Indicates if the expression is simple.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setIsExpressionSimple in interface ILabelEngineLayerProperties
Specified by:
setIsExpressionSimple in interface ILabelEngineLayerProperties2
Parameters:
simpleExpression - The simpleExpression (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExpressionSimple

public boolean isExpressionSimple()
                           throws IOException,
                                  AutomationException
Indicates if the expression is simple.

Description

IsExpressionSimple specifies whether or not the expression contains full code or a simple expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isExpressionSimple in interface ILabelEngineLayerProperties
Specified by:
isExpressionSimple in interface ILabelEngineLayerProperties2
Returns:
The simpleExpression
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpressionParserByRef

public void setExpressionParserByRef(IAnnotationExpressionEngine engine)
                              throws IOException,
                                     AutomationException
The object that interprets the expression.

Product Availability

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

Specified by:
setExpressionParserByRef in interface ILabelEngineLayerProperties
Specified by:
setExpressionParserByRef in interface ILabelEngineLayerProperties2
Parameters:
engine - A reference to a com.esri.arcgis.carto.IAnnotationExpressionEngine (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExpressionParser

public IAnnotationExpressionEngine getExpressionParser()
                                                throws IOException,
                                                       AutomationException
The object that interprets the expression.

Description

ExpressionParser is the parser that interprets the expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExpressionParser in interface ILabelEngineLayerProperties
Specified by:
getExpressionParser in interface ILabelEngineLayerProperties2
Returns:
A reference to a com.esri.arcgis.carto.IAnnotationExpressionEngine
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnnotationClassID

public void setAnnotationClassID(int annotationClassID)
                          throws IOException,
                                 AutomationException
The ID of the annotation class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setAnnotationClassID in interface ILabelEngineLayerProperties2
Parameters:
annotationClassID - The annotationClassID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationClassID

public int getAnnotationClassID()
                         throws IOException,
                                AutomationException
The ID of the annotation class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getAnnotationClassID in interface ILabelEngineLayerProperties2
Returns:
The annotationClassID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverposterLayerPropertiesByRef

public void setOverposterLayerPropertiesByRef(IOverposterLayerProperties props)
                                       throws IOException,
                                              AutomationException
The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Specified by:
setOverposterLayerPropertiesByRef in interface ILabelEngineLayerProperties2
Parameters:
props - A reference to a com.esri.arcgis.carto.IOverposterLayerProperties (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOverposterLayerProperties

public IOverposterLayerProperties getOverposterLayerProperties()
                                                        throws IOException,
                                                               AutomationException
The overposter properties, which specify how labels are placed relative to features.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getOverposterLayerProperties in interface ILabelEngineLayerProperties2
Returns:
A reference to a com.esri.arcgis.carto.IOverposterLayerProperties
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBounds

public void setBounds(IEnvelope bounds)
               throws IOException,
                      AutomationException
The full extent in world coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBounds in interface IAnnotateLayerTransformationProperties
Parameters:
bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBounds

public IEnvelope getBounds()
                    throws IOException,
                           AutomationException
The full extent in world coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBounds in interface IAnnotateLayerTransformationProperties
Returns:
A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUnits

public int getUnits()
             throws IOException,
                    AutomationException
The units of the world coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getUnits in interface IAnnotateLayerTransformationProperties
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUnits

public void setUnits(int unitsCode)
              throws IOException,
                     AutomationException
The units of the world coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUnits in interface IAnnotateLayerTransformationProperties
Parameters:
unitsCode - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getScaleRatio

public double getScaleRatio()
                     throws IOException,
                            AutomationException
Scale ratio of the transformation. Based on IAnnotationLayerProperties.Extent and Bounds.

Remarks

The ScaleRatio represents the ratio between graphics displayed in the map versus the objects in the real world. In this usage, it is the same as IAnnotateLayerTransformationProperties::ReferenceScale.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getScaleRatio in interface IAnnotateLayerTransformationProperties
Returns:
The scale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setScaleRatio

public void setScaleRatio(double scale)
                   throws IOException,
                          AutomationException
Scale ratio of the transformation. Based on IAnnotationLayerProperties.Extent and Bounds.

Remarks

The ScaleRatio represents the ratio between graphics displayed in the map versus the objects in the real world. In this usage, it is the same as IAnnotateLayerTransformationProperties::ReferenceScale.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setScaleRatio in interface IAnnotateLayerTransformationProperties
Parameters:
scale - The scale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReferenceScale

public double getReferenceScale()
                         throws IOException,
                                AutomationException
Reference scale for computing scaled symbol sizes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getReferenceScale in interface IAnnotateLayerTransformationProperties
Returns:
The scale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReferenceScale

public void setReferenceScale(double scale)
                       throws IOException,
                              AutomationException
Reference scale for computing scaled symbol sizes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setReferenceScale in interface IAnnotateLayerTransformationProperties
Parameters:
scale - The scale (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
assign in interface IClone
Parameters:
src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException