com.esri.arcgis.carto
Interface ILabelEngineLayerProperties2

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ILabelEngineLayerProperties2Proxy, LabelEngineLayerProperties, MaplexLabelEngineLayerProperties

public interface ILabelEngineLayerProperties2
extends java.io.Serializable

COM Interface 'ILabelEngineLayerProperties2'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to some of the main properties for labeling features.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID59a8eeba_8ef7_4143_b497_4efcaf6a2405
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 int getAnnotationClassID()
          The ID of the annotation class.
 IBasicOverposterLayerProperties getBasicOverposterLayerProperties()
          The overposter properties, which specify how labels are placed relative to features.
 java.lang.String getExpression()
          The VBScript or JScript expression that evaluates and formats the label.
 IAnnotationExpressionEngine getExpressionParser()
          The object that interprets the expression.
 double getOffset()
          The offset between the label and the feature.
 IOverposterLayerProperties getOverposterLayerProperties()
          The overposter properties, which specify how labels are placed relative to features.
 ITextSymbol getSymbol()
          The text symbol used to draw the label.
 int getSymbolID()
          The ID of the group symbol used to draw the label.
 boolean isExpressionSimple()
          Indicates if the expression is simple.
 void setAnnotationClassID(int annotationClassID)
          The ID of the annotation class.
 void setBasicOverposterLayerPropertiesByRef(IBasicOverposterLayerProperties props)
          The overposter properties, which specify how labels are placed relative to features.
 void setExpression(java.lang.String expression)
          The VBScript or JScript expression that evaluates and formats the label.
 void setExpressionParserByRef(IAnnotationExpressionEngine engine)
          The object that interprets the expression.
 void setIsExpressionSimple(boolean simpleExpression)
          Indicates if the expression is simple.
 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 setSymbolByRef(ITextSymbol textSymbol)
          The text symbol used to draw the label.
 void setSymbolID(int symbolID)
          The ID of the group symbol used to draw the label.
 

Field Detail

IID59a8eeba_8ef7_4143_b497_4efcaf6a2405

static final int IID59a8eeba_8ef7_4143_b497_4efcaf6a2405
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

setSymbolByRef

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

Parameters:
textSymbol - A reference to a com.esri.arcgis.display.ITextSymbol (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbol

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

Returns:
A reference to a com.esri.arcgis.display.ITextSymbol
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSymbolID

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

Parameters:
symbolID - The symbolID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSymbolID

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

Returns:
The symbolID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOffset

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

Parameters:
offset - The offset (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOffset

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

Returns:
The offset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBasicOverposterLayerPropertiesByRef

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

Parameters:
props - A reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBasicOverposterLayerProperties

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

Returns:
A reference to a com.esri.arcgis.carto.IBasicOverposterLayerProperties
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpression

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

Parameters:
expression - The expression (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExpression

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

Returns:
The expression
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsExpressionSimple

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

Parameters:
simpleExpression - The simpleExpression (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isExpressionSimple

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

Returns:
The simpleExpression
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpressionParserByRef

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

Parameters:
engine - A reference to a com.esri.arcgis.carto.IAnnotationExpressionEngine (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExpressionParser

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

Returns:
A reference to a com.esri.arcgis.carto.IAnnotationExpressionEngine
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAnnotationClassID

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

Parameters:
annotationClassID - The annotationClassID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAnnotationClassID

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

Returns:
The annotationClassID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOverposterLayerPropertiesByRef

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

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

getOverposterLayerProperties

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

Returns:
A reference to a com.esri.arcgis.carto.IOverposterLayerProperties
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.