com.esri.arcgis.carto
Class DimensionStyle

java.lang.Object
  extended by com.esri.arcgis.carto.DimensionStyle
All Implemented Interfaces:
IDimensionStyle, IDimensionStyleDisplay, IDimensionStyleText, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, Externalizable, Serializable

public class DimensionStyle
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDimensionStyle, IDimensionStyleDisplay, IDimensionStyleText, IPersistStream, IClone, Externalizable

A container of properties which dictate how a dimension feature is displayed.

Description

The DimensionStyle coclass defines properties for controlling the symbology of dimension featrues.

Remarks

The DimensionStyle coclass supports three interfaces for managing the symbology, behavior, and text of a dimension feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
DimensionStyle()
          Constructs a DimensionStyle using ArcGIS Engine.
DimensionStyle(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
DimensionStyle theDimensionStyle = (DimensionStyle) 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.
 double getBaselineHeight()
          Height of the construction for creating baseline dimensions with this style.
 IMarkerSymbol getBeginMarkerSymbol()
          Symbol used for the begin arrow.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 int getDimensionLineDisplay()
          Dimension line display of the style.
 ILineSymbol getDimensionLineSymbol()
          Symbol used for the dimension line.
 int getDisplayPrecision()
          Precision for the value displayed by the dimension text.
 int getDisplayUnits()
          Units the length of the dimension text is displayed in.
 IMarkerSymbol getEndMarkerSymbol()
          Symbol used for the end arrow.
 String getExpression()
          Text expression for the style.
 String getExpressionParserName()
          Text expression parser for the text expression for the style.
 int getExtensionLineDisplay()
          Extension line display of the style.
 double getExtensionLineOffset()
          Length of the extension line offset.
 double getExtensionLineOvershot()
          Length of the extension line overshot.
 ILineSymbol getExtensionLineSymbol()
          Symbol used for the extension lines.
 int getID()
          ID of the style.
 int getMarkerDisplay()
          Arrow display of the style.
 int getMarkerFit()
          Arrow fit policy of the style.
 double getMarkerFitTolerance()
          Arrow fit tolerance of the style.
 String getName()
          Name of the style.
 String getPrefix()
          Prefix for the text expression for the style.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 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.
 int hashCode()
          the hashcode for this object
 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.
 void isDirty()
          isDirty
 boolean isDrawLineOnFit()
          Indicates if a dimension line should be drawn between the extension lines for an inward dimension.
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 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.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setAlign(boolean align)
          Indicates if the text should be aligned with the dimension line.
 void setBaselineHeight(double height)
          Height of the construction for creating baseline dimensions with this style.
 void setBeginMarkerSymbol(IMarkerSymbol symbol)
          Symbol used for the begin arrow.
 void setConvertUnits(boolean convert)
          Indicates if the length of the dimension needs to be converted for display.
 void setDimensionLineDisplay(int displayOption)
          Dimension line display of the style.
 void setDimensionLineSymbol(ILineSymbol symbol)
          Symbol used for the dimension line.
 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 setDrawLineOnFit(boolean draw)
          Indicates if a dimension line should be drawn between the extension lines for an inward dimension.
 void setEndMarkerSymbol(IMarkerSymbol symbol)
          Symbol used for the end arrow.
 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 setExtensionLineDisplay(int displayOption)
          Extension line display of the style.
 void setExtensionLineOffset(double offset)
          Length of the extension line offset.
 void setExtensionLineOvershot(double overshot)
          Length of the extension line overshot.
 void setExtensionLineSymbol(ILineSymbol symbol)
          Symbol used for the extension lines.
 void setMarkerDisplay(int displayOption)
          Arrow display of the style.
 void setMarkerFit(int fit)
          Arrow fit policy of the style.
 void setMarkerFitTolerance(double tolerance)
          Arrow fit tolerance of the style.
 void setName(String name)
          Name of the style.
 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.
 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

DimensionStyle

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

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

DimensionStyle

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

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

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

getID

public int getID()
          throws IOException,
                 AutomationException
ID of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getID in interface IDimensionStyle
Returns:
The iD
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException
Name of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getName

public String getName()
               throws IOException,
                      AutomationException
Name of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IDimensionStyle
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDimensionLineSymbol

public void setDimensionLineSymbol(ILineSymbol symbol)
                            throws IOException,
                                   AutomationException
Symbol used for the dimension line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDimensionLineSymbol in interface IDimensionStyleDisplay
Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDimensionLineSymbol

public ILineSymbol getDimensionLineSymbol()
                                   throws IOException,
                                          AutomationException
Symbol used for the dimension line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExtensionLineSymbol

public void setExtensionLineSymbol(ILineSymbol symbol)
                            throws IOException,
                                   AutomationException
Symbol used for the extension lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setExtensionLineSymbol in interface IDimensionStyleDisplay
Parameters:
symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionLineSymbol

public ILineSymbol getExtensionLineSymbol()
                                   throws IOException,
                                          AutomationException
Symbol used for the extension lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setBeginMarkerSymbol

public void setBeginMarkerSymbol(IMarkerSymbol symbol)
                          throws IOException,
                                 AutomationException
Symbol used for the begin arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBeginMarkerSymbol in interface IDimensionStyleDisplay
Parameters:
symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBeginMarkerSymbol

public IMarkerSymbol getBeginMarkerSymbol()
                                   throws IOException,
                                          AutomationException
Symbol used for the begin arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setEndMarkerSymbol

public void setEndMarkerSymbol(IMarkerSymbol symbol)
                        throws IOException,
                               AutomationException
Symbol used for the end arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setEndMarkerSymbol in interface IDimensionStyleDisplay
Parameters:
symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndMarkerSymbol

public IMarkerSymbol getEndMarkerSymbol()
                                 throws IOException,
                                        AutomationException
Symbol used for the end arrow.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExtensionLineOvershot

public void setExtensionLineOvershot(double overshot)
                              throws IOException,
                                     AutomationException
Length of the extension line overshot.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getExtensionLineOvershot

public double getExtensionLineOvershot()
                                throws IOException,
                                       AutomationException
Length of the extension line overshot.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExtensionLineOvershot in interface IDimensionStyleDisplay
Returns:
The overshot
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExtensionLineOffset

public void setExtensionLineOffset(double offset)
                            throws IOException,
                                   AutomationException
Length of the extension line offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getExtensionLineOffset

public double getExtensionLineOffset()
                              throws IOException,
                                     AutomationException
Length of the extension line offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDimensionLineDisplay

public void setDimensionLineDisplay(int displayOption)
                             throws IOException,
                                    AutomationException
Dimension line display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDimensionLineDisplay in interface IDimensionStyleDisplay
Parameters:
displayOption - A com.esri.arcgis.carto.esriDimensionDisplay constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDimensionLineDisplay

public int getDimensionLineDisplay()
                            throws IOException,
                                   AutomationException
Dimension line display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExtensionLineDisplay

public void setExtensionLineDisplay(int displayOption)
                             throws IOException,
                                    AutomationException
Extension line display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setExtensionLineDisplay in interface IDimensionStyleDisplay
Parameters:
displayOption - A com.esri.arcgis.carto.esriDimensionDisplay constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtensionLineDisplay

public int getExtensionLineDisplay()
                            throws IOException,
                                   AutomationException
Extension line display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMarkerDisplay

public void setMarkerDisplay(int displayOption)
                      throws IOException,
                             AutomationException
Arrow display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMarkerDisplay in interface IDimensionStyleDisplay
Parameters:
displayOption - A com.esri.arcgis.carto.esriDimensionDisplay constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMarkerDisplay

public int getMarkerDisplay()
                     throws IOException,
                            AutomationException
Arrow display of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMarkerFit

public void setMarkerFit(int fit)
                  throws IOException,
                         AutomationException
Arrow fit policy of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setMarkerFit in interface IDimensionStyleDisplay
Parameters:
fit - A com.esri.arcgis.carto.esriDimensionMarkerFit constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMarkerFit

public int getMarkerFit()
                 throws IOException,
                        AutomationException
Arrow fit policy of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMarkerFitTolerance

public void setMarkerFitTolerance(double tolerance)
                           throws IOException,
                                  AutomationException
Arrow fit tolerance of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMarkerFitTolerance

public double getMarkerFitTolerance()
                             throws IOException,
                                    AutomationException
Arrow fit tolerance of the style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMarkerFitTolerance in interface IDimensionStyleDisplay
Returns:
The tolerance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDrawLineOnFit

public void setDrawLineOnFit(boolean draw)
                      throws IOException,
                             AutomationException
Indicates if a dimension line should be drawn between the extension lines for an inward dimension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isDrawLineOnFit

public boolean isDrawLineOnFit()
                        throws IOException,
                               AutomationException
Indicates if a dimension line should be drawn between the extension lines for an inward dimension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDrawLineOnFit in interface IDimensionStyleDisplay
Returns:
The draw
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBaselineHeight

public void setBaselineHeight(double height)
                       throws IOException,
                              AutomationException
Height of the construction for creating baseline dimensions with this style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBaselineHeight

public double getBaselineHeight()
                         throws IOException,
                                AutomationException
Height of the construction for creating baseline dimensions with this style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getBaselineHeight in interface IDimensionStyleDisplay
Returns:
The height
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextSymbol

public 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

Specified by:
setTextSymbol in interface IDimensionStyleText
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

public 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

Specified by:
getTextSymbol in interface IDimensionStyleText
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

public 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

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

isAlign

public 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

Specified by:
isAlign in interface IDimensionStyleText
Returns:
The align
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayUnits

public 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

Specified by:
setDisplayUnits in interface IDimensionStyleText
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

public 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

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

setConvertUnits

public 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

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

isConvertUnits

public 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

Specified by:
isConvertUnits in interface IDimensionStyleText
Returns:
The convert
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayPrecision

public 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

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

getDisplayPrecision

public 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

Specified by:
getDisplayPrecision in interface IDimensionStyleText
Returns:
The precision
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextDisplay

public 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

Specified by:
setTextDisplay in interface IDimensionStyleText
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

public 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

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

setExpression

public 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

Specified by:
setExpression in interface IDimensionStyleText
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
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

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

setExpressionParserName

public 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

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

getExpressionParserName

public 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 “VB Script” and “Java Script”.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getExpressionParserName in interface IDimensionStyleText
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setExpressionSimple

public 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

Specified by:
setExpressionSimple in interface IDimensionStyleText
Parameters:
isSimple - The isSimple (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 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

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

setPrefix

public 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

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

getPrefix

public 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

Specified by:
getPrefix in interface IDimensionStyleText
Returns:
The prefix
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSuffix

public 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

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

getSuffix

public 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

Specified by:
getSuffix in interface IDimensionStyleText
Returns:
The suffix
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextFit

public 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

Specified by:
setTextFit in interface IDimensionStyleText
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

public 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

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

setExtendLineOnFit

public 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

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

isExtendLineOnFit

public 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

Specified by:
isExtendLineOnFit in interface IDimensionStyleText
Returns:
The draw
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