com.esri.arcgis.carto
Interface IDimensionStyleText

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DimensionStyle, IDimensionStyleTextProxy

public interface IDimensionStyleText
extends java.io.Serializable

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

Description: 'Provides access to members that control a dimension style's text.' 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	IIDf9316364_f92a_11d3_80d3_00c04f601565
static int	xxDummy Deprecated. Internal use only

Method Summary

int	getDisplayPrecision() Precision for the value displayed by the dimension text.
int	getDisplayUnits() Units the length of the dimension text is displayed in.
java.lang.String	getExpression() Text expression for the style.
java.lang.String	getExpressionParserName() Text expression parser for the text expression for the style.
java.lang.String	getPrefix() Prefix for the text expression for the style.
java.lang.String	getSuffix() Suffix for the text expression for the style.
int	getTextDisplay() Text display setting for the style.
int	getTextFit() Text fit policy for the style.
ITextSymbol	getTextSymbol() Symbol used for the text.
boolean	isAlign() Indicates if the text should be aligned with the dimension line.
boolean	isConvertUnits() Indicates if the length of the dimension needs to be converted for display.
boolean	isExpressionSimple() Indicates if the text expression is simple or custom for the style.
boolean	isExtendLineOnFit() Indicates if the dimension line will be extended to underline the text on inward dimensions.
void	setAlign(boolean align) Indicates if the text should be aligned with the dimension line.
void	setConvertUnits(boolean convert) Indicates if the length of the dimension needs to be converted for display.
void	setDisplayPrecision(int precision) Precision for the value displayed by the dimension text.
void	setDisplayUnits(int units) Units the length of the dimension text is displayed in.
void	setExpression(java.lang.String expression) Text expression for the style.
void	setExpressionParserName(java.lang.String name) Text expression parser for the text expression for the style.
void	setExpressionSimple(boolean isSimple) Indicates if the text expression is simple or custom for the style.
void	setExtendLineOnFit(boolean draw) Indicates if the dimension line will be extended to underline the text on inward dimensions.
void	setPrefix(java.lang.String prefix) Prefix for the text expression for the style.
void	setSuffix(java.lang.String suffix) Suffix for the text expression for the style.
void	setTextDisplay(int display) Text display setting for the style.
void	setTextFit(int fit) Text fit policy for the style.
void	setTextSymbol(ITextSymbol symbol) Symbol used for the text.

Field Detail

IIDf9316364_f92a_11d3_80d3_00c04f601565

static final int IIDf9316364_f92a_11d3_80d3_00c04f601565

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

setTextSymbol

void setTextSymbol(ITextSymbol symbol)
                   throws java.io.IOException,
                          AutomationException

Symbol used for the text.

Parameters:

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

getTextSymbol

ITextSymbol getTextSymbol()
                          throws java.io.IOException,
                                 AutomationException

Symbol used for the text.

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.

setAlign

void setAlign(boolean align)
              throws java.io.IOException,
                     AutomationException

Indicates if the text should be aligned with the dimension line.

Parameters:

align - The align (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAlign

boolean isAlign()
                throws java.io.IOException,
                       AutomationException

Indicates if the text should be aligned with the dimension line.

Returns:

The align

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayUnits

void setDisplayUnits(int units)
                     throws java.io.IOException,
                            AutomationException

Units the length of the dimension text is displayed in.

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayUnits

int getDisplayUnits()
                    throws java.io.IOException,
                           AutomationException

Units the length of the dimension text is displayed in.

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConvertUnits

void setConvertUnits(boolean convert)
                     throws java.io.IOException,
                            AutomationException

Indicates if the length of the dimension needs to be converted for display.

Parameters:

convert - The convert (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isConvertUnits

boolean isConvertUnits()
                       throws java.io.IOException,
                              AutomationException

Indicates if the length of the dimension needs to be converted for display.

Returns:

The convert

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayPrecision

void setDisplayPrecision(int precision)
                         throws java.io.IOException,
                                AutomationException

Precision for the value displayed by the dimension text.

Parameters:

precision - The precision (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayPrecision

int getDisplayPrecision()
                        throws java.io.IOException,
                               AutomationException

Precision for the value displayed by the dimension text.

Returns:

The precision

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextDisplay

void setTextDisplay(int display)
                    throws java.io.IOException,
                           AutomationException

Text display setting for the style.

Parameters:

display - A com.esri.arcgis.carto.esriDimensionTextDisplay constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextDisplay

int getTextDisplay()
                   throws java.io.IOException,
                          AutomationException

Text display setting for the style.

Returns:

A com.esri.arcgis.carto.esriDimensionTextDisplay constant

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

Text expression for the style.

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

Text expression for the style.

Returns:

The expression

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionParserName

void setExpressionParserName(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException

Text expression parser for the text expression for the style.

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpressionParserName

java.lang.String getExpressionParserName()
                                         throws java.io.IOException,
                                                AutomationException

Text expression parser for the text expression for the style.

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionSimple

void setExpressionSimple(boolean isSimple)
                         throws java.io.IOException,
                                AutomationException

Indicates if the text expression is simple or custom for the style.

Parameters:

isSimple - The isSimple (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 text expression is simple or custom for the style.

Returns:

The isSimple

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrefix

void setPrefix(java.lang.String prefix)
               throws java.io.IOException,
                      AutomationException

Prefix for the text expression for the style.

Parameters:

prefix - The prefix (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrefix

java.lang.String getPrefix()
                           throws java.io.IOException,
                                  AutomationException

Prefix for the text expression for the style.

Returns:

The prefix

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuffix

void setSuffix(java.lang.String suffix)
               throws java.io.IOException,
                      AutomationException

Suffix for the text expression for the style.

Parameters:

suffix - The suffix (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSuffix

java.lang.String getSuffix()
                           throws java.io.IOException,
                                  AutomationException

Suffix for the text expression for the style.

Returns:

The suffix

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextFit

void setTextFit(int fit)
                throws java.io.IOException,
                       AutomationException

Text fit policy for the style.

Parameters:

fit - A com.esri.arcgis.carto.esriDimensionTextFit constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextFit

int getTextFit()
               throws java.io.IOException,
                      AutomationException

Text fit policy for the style.

Returns:

A com.esri.arcgis.carto.esriDimensionTextFit constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendLineOnFit

void setExtendLineOnFit(boolean draw)
                        throws java.io.IOException,
                               AutomationException

Indicates if the dimension line will be extended to underline the text on inward dimensions.

Parameters:

draw - The draw (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExtendLineOnFit

boolean isExtendLineOnFit()
                          throws java.io.IOException,
                                 AutomationException

Indicates if the dimension line will be extended to underline the text on inward dimensions.

Returns:

The draw

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.