com.esri.arcgis.carto
Interface IDimensionStyleText

All Superinterfaces:

Serializable

All Known Implementing Classes:

DimensionStyle

public interface IDimensionStyleText
extends Serializable

Provides access to members that control a dimension style's text.

Description

The IDimensionStyleText interface contains properties that control how the text of a dimension feature is displayed.

Remarks

The Align property will force the text to align to the angle of the DimensionLine. If the Align property is False, the TextSymbol’s angle will be used. The ConvertUnits property specifies if the value of the text will be converted from the feature class’s native units to the units of the DisplayUnits property. The text can be formatted using the DisplayPrecision property and the TextDisplay property. The esriDimensionTextDisplay enumeration defines four values for formatting the text string:

esriDimensionTDValueOnly - Displays only the numeric value.
esriDimensionTDPrefixSuffix - Displays the numeric value with the Prefix and Suffix property.
esriDimensionTDExpression - Evaluate the numeric value in the code expression.
esriDimensionTDNone - Do not display text.

The text string can also be determined from an expression specified in the Expression property. The expression can be a simple concatenation of column values and strings or a function written in scripting language. The name of the parser for the expression should be specified in the ExpressionParserName property. The currently available parsers are "VBScript", "JScript", and "Python".

The TextFit property determines where the text will be placed if it does not fit between the markers after they have been moved (due to marker fit settings). The esriDimensionTextFit enumeration defines three values for this behavior:

esriDimensionTextFitNone - Do not move text.
esriDimensionTextFitMoveBegin - Move text to beginning dimension line.
esriDimensionTextFitMoveEnd - Move text to ending dimension line.

When the markers are moved because of a fit, a line will be drawn between the markers based on the DrawLineOnFit property.

Product Availability

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

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.
String	getExpression() Text expression for the style.
String	getExpressionParserName() Text expression parser for the text expression for the style.
String	getPrefix() Prefix for the text expression for the style.
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(String expression) Text expression for the style.
void	setExpressionParserName(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(String prefix) Prefix for the text expression for the style.
void	setSuffix(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.

Method Detail

setTextSymbol

void setTextSymbol(ITextSymbol symbol)
                   throws IOException,
                          AutomationException

Symbol used for the text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

getTextSymbol

ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

Symbol used for the text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

setAlign

void setAlign(boolean align)
              throws IOException,
                     AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

align - The align (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAlign

boolean isAlign()
                throws IOException,
                       AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The align

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayUnits

void setDisplayUnits(int units)
                     throws IOException,
                            AutomationException

Units the length of the dimension text is displayed in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayUnits

int getDisplayUnits()
                    throws IOException,
                           AutomationException

Units the length of the dimension text is displayed in.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setConvertUnits

void setConvertUnits(boolean convert)
                     throws IOException,
                            AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

convert - The convert (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isConvertUnits

boolean isConvertUnits()
                       throws IOException,
                              AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The convert

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayPrecision

void setDisplayPrecision(int precision)
                         throws IOException,
                                AutomationException

Precision for the value displayed by the dimension text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

precision - The precision (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDisplayPrecision

int getDisplayPrecision()
                        throws IOException,
                               AutomationException

Precision for the value displayed by the dimension text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The precision

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextDisplay

void setTextDisplay(int display)
                    throws IOException,
                           AutomationException

Text display setting for the style.

Remarks

The esriDimensionTextDisplay enumeration defines four values for formatting the text string:

esriDimensionTDValueOnly - Displays only the numeric value.
esriDimensionTDPrefixSuffix - Displays the numeric value with the Prefix and Suffix property.
esriDimensionTDExpression - Evaluate the numeric value in the code expression.
esriDimensionTDNone - Do not display text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextDisplay

int getTextDisplay()
                   throws IOException,
                          AutomationException

Text display setting for the style.

Remarks

The esriDimensionTextDisplay enumeration defines four values for formatting the text string:

esriDimensionTDValueOnly - Displays only the numeric value.
esriDimensionTDPrefixSuffix - Displays the numeric value with the Prefix and Suffix property.
esriDimensionTDExpression - Evaluate the numeric value in the code expression.
esriDimensionTDNone - Do not display text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriDimensionTextDisplay constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpression

void setExpression(String expression)
                   throws IOException,
                          AutomationException

Text expression for the style.

Remarks

The text string can also be determined from an expression specified in the Expression property. The expression can be a simple concatenation of column values and strings or a function written in scripting language. The name of the parser for the expression should be specified in the ExpressionParserName property. The currently available parsers are “VB Script” and “Java Script”.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

expression - The expression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpression

String getExpression()
                     throws IOException,
                            AutomationException

Text expression for the style.

Remarks

The text string can also be determined from an expression specified in the Expression property. The expression can be a simple concatenation of column values and strings or a function written in scripting language. The name of the parser for the expression should be specified in the ExpressionParserName property. The currently available parsers are “VB Script” and “Java Script”.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The expression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionParserName

void setExpressionParserName(String name)
                             throws IOException,
                                    AutomationException

Text expression parser for the text expression for the style.

Remarks

The text string can also be determined from an expression specified in the Expression property. The expression can be a simple concatenation of column values and strings or a function written in scripting language. The name of the parser for the expression should be specified in the ExpressionParserName property. The currently available parsers are “VB Script” and “Java Script”.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExpressionParserName

String getExpressionParserName()
                               throws IOException,
                                      AutomationException

Text expression parser for the text expression for the style.

Remarks

The text string can also be determined from an expression specified in the Expression property. The expression can be a simple concatenation of column values and strings or a function written in scripting language. The name of the parser for the expression should be specified in the ExpressionParserName property. The currently available parsers are VBScript, JScript and Python which are represented respectively by the strings "VBScript", "JScript", and "Python". The strings "VB Script" and "Java Script" may be used for backward compatibility with ArcGIS versions prior to 10.1 where these names were used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExpressionSimple

void setExpressionSimple(boolean isSimple)
                         throws IOException,
                                AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

isSimple - The isSimple (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExpressionSimple

boolean isExpressionSimple()
                           throws IOException,
                                  AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The isSimple

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrefix

void setPrefix(String prefix)
               throws IOException,
                      AutomationException

Prefix for the text expression for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

prefix - The prefix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrefix

String getPrefix()
                 throws IOException,
                        AutomationException

Prefix for the text expression for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The prefix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuffix

void setSuffix(String suffix)
               throws IOException,
                      AutomationException

Suffix for the text expression for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

suffix - The suffix (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSuffix

String getSuffix()
                 throws IOException,
                        AutomationException

Suffix for the text expression for the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The suffix

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextFit

void setTextFit(int fit)
                throws IOException,
                       AutomationException

Text fit policy for the style.

Remarks

The TextFit property determines where the text will be placed if it does not fit between the markers after they have been moved (due to marker fit settings). The esriDimensionTextFit enumeration defines three values for this behavior:

esriDimensionTextFitNone - Do not move text.
esriDimensionTextFitMoveBegin - Move text to beginning dimension line.
esriDimensionTextFitMoveEnd - Move text to ending dimension line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextFit

int getTextFit()
               throws IOException,
                      AutomationException

Text fit policy for the style.

Remarks

The TextFit property determines where the text will be placed if it does not fit between the markers after they have been moved (due to marker fit settings). The esriDimensionTextFit enumeration defines three values for this behavior:

esriDimensionTextFitNone - Do not move text.
esriDimensionTextFitMoveBegin - Move text to beginning dimension line.
esriDimensionTextFitMoveEnd - Move text to ending dimension line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.carto.esriDimensionTextFit constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendLineOnFit

void setExtendLineOnFit(boolean draw)
                        throws IOException,
                               AutomationException

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

Remarks

When the markers are moved because of a fit, a line will be drawn between the markers based on the DrawLineOnFit property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

draw - The draw (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExtendLineOnFit

boolean isExtendLineOnFit()
                          throws IOException,
                                 AutomationException

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

Remarks

When the markers are moved because of a fit, a line will be drawn between the markers based on the DrawLineOnFit property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The draw

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.