com.esri.arcgis.carto
Interface ILabelEngineLayerProperties

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ILabelEngineLayerPropertiesProxy, LabelEngineLayerProperties, MaplexLabelEngineLayerProperties

public interface ILabelEngineLayerProperties
extends java.io.Serializable

COM Interface 'ILabelEngineLayerProperties'. 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	IID01004143_0d1c_11d2_a26f_080009b6f22b
static int	xxDummy Deprecated. Internal use only

Method Summary

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.
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	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	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.

Field Detail

IID01004143_0d1c_11d2_a26f_080009b6f22b

static final int IID01004143_0d1c_11d2_a26f_080009b6f22b

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 pSymbolID)
                 throws java.io.IOException,
                        AutomationException

The ID of the group symbol used to draw the label.

Parameters:

pSymbolID - The pSymbolID (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 pSymbolID

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.