com.esri.arcgis.carto
Interface IDimensionGraphic

All Superinterfaces:
Serializable
All Known Implementing Classes:
DimensionGraphic

public interface IDimensionGraphic
extends Serializable

Provides access to members that control a dimension graphic.

Description

The IDimensionGraphic interface provides methods and properties for drawing dimensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void draw(int hDC, ITransformation transformation)
          Draws the dimension style.
 double getCustomLength()
          The custom length of the dimension graphic.
 IPoint getDefaultTextPoint()
          The default location of the dimension text placement.
 IDimensionShape getDimensionShape()
          The begin dimension point.
 double getLength()
          The length of the dimension graphic.
 void getMask(int hDC, ITransformation transformation, IGeometry mask)
          The dimension graphic mask.
 ITransformation getNativeTransformation()
          The native transformation for the dimension graphic.
 int getNativeUnits()
          The native units of the dimension graphic.
 IDimensionStyle getStyle()
          The dimension style.
 boolean isUseCustomLength()
          Indicates if a custom length is displayed for the dimsnion graphic.
 void queryBoundary(int hDC, ITransformation transformation, IPolygon boundary)
          The boundary of the dimension style.
 void setCustomLength(double length)
          The custom length of the dimension graphic.
 void setDimensionShapeByRef(IDimensionShape shape)
          The begin dimension point.
 void setNativeTransformationByRef(ITransformation transformation)
          The native transformation for the dimension graphic.
 void setNativeUnits(int units)
          The native units of the dimension graphic.
 void setStyleByRef(IDimensionStyle style)
          The dimension style.
 void setUseCustomLength(boolean length)
          Indicates if a custom length is displayed for the dimsnion graphic.
 void updateShape(int hDC, ITransformation transformation, IFeature pFeature)
          Updates the dimension geometries for the dimension graphic.
 

Method Detail

setDimensionShapeByRef

void setDimensionShapeByRef(IDimensionShape shape)
                            throws IOException,
                                   AutomationException
The begin dimension point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDimensionShape

IDimensionShape getDimensionShape()
                                  throws IOException,
                                         AutomationException
The begin dimension point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getStyle

IDimensionStyle getStyle()
                         throws IOException,
                                AutomationException
The dimension style.

Remarks

The Style property sets the DimensionStyle for the DimensionGraphic. The DimensionShape defines the location of the dimensionís measurements and 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.carto.IDimensionStyle
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStyleByRef

void setStyleByRef(IDimensionStyle style)
                   throws IOException,
                          AutomationException
The dimension style.

Remarks

The Style property sets the DimensionStyle for the DimensionGraphic. The DimensionShape defines the location of the dimensionís measurements and text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

draw

void draw(int hDC,
          ITransformation transformation)
          throws IOException,
                 AutomationException
Draws the dimension style.

Remarks

The Draw method draws a dimension on the device context specified by the hDC parameter using the transformation specified in the pTransformation parameter.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
hDC - The hDC (A COM typedef) (in)
transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryBoundary

void queryBoundary(int hDC,
                   ITransformation transformation,
                   IPolygon boundary)
                   throws IOException,
                          AutomationException
The boundary of the dimension style.

Remarks

The QueryBoundary method returns the Envelope of the dimension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
hDC - The hDC (A COM typedef) (in)
transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
boundary - A reference to a com.esri.arcgis.geometry.IPolygon (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLength

double getLength()
                 throws IOException,
                        AutomationException
The length of the dimension graphic.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCustomLength

double getCustomLength()
                       throws IOException,
                              AutomationException
The custom length of the dimension graphic.

Remarks

The Length property returns the current calculated length for the Dimension. A custom length value can be specified using the CustomLength and UseCustomLength properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCustomLength

void setCustomLength(double length)
                     throws IOException,
                            AutomationException
The custom length of the dimension graphic.

Remarks

The Length property returns the current calculated length for the Dimension. A custom length value can be specified using the CustomLength and UseCustomLength properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isUseCustomLength

boolean isUseCustomLength()
                          throws IOException,
                                 AutomationException
Indicates if a custom length is displayed for the dimsnion graphic.

Remarks

The Length property returns the current calculated length for the Dimension. A custom length value can be specified using the CustomLength and UseCustomLength properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUseCustomLength

void setUseCustomLength(boolean length)
                        throws IOException,
                               AutomationException
Indicates if a custom length is displayed for the dimsnion graphic.

Remarks

The Length property returns the current calculated length for the Dimension. A custom length value can be specified using the CustomLength and UseCustomLength properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMask

void getMask(int hDC,
             ITransformation transformation,
             IGeometry mask)
             throws IOException,
                    AutomationException
The dimension graphic mask.

Remarks

The GetMask method returns the outline polygon of the dimension.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
hDC - The hDC (A COM typedef) (in)
transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
mask - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateShape

void updateShape(int hDC,
                 ITransformation transformation,
                 IFeature pFeature)
                 throws IOException,
                        AutomationException
Updates the dimension geometries for the dimension graphic.

Remarks

If the properties of the DimensionGraphic are changed, it is necessary to call the UpdateShape method to recalculate the dimension. The pFeature parameter of the UpdateShape method is only necessary when the current style is using a text expression.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
hDC - The hDC (A COM typedef) (in)
transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
pFeature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNativeUnits

int getNativeUnits()
                   throws IOException,
                          AutomationException
The native units of the dimension graphic.

Remarks

If the current DimensionStyle supports text value conversion, the native units and transformation can be set with the NativeUnits and NativeTransformation properties.

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.

setNativeUnits

void setNativeUnits(int units)
                    throws IOException,
                           AutomationException
The native units of the dimension graphic.

Remarks

If the current DimensionStyle supports text value conversion, the native units and transformation can be set with the NativeUnits and NativeTransformation properties.

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.

getDefaultTextPoint

IPoint getDefaultTextPoint()
                           throws IOException,
                                  AutomationException
The default location of the dimension text placement.

Remarks

If the current DimensionShape contains a non-empty TextPoint, the default location for the text is available through the GetDefaultTextPoint method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getNativeTransformation

ITransformation getNativeTransformation()
                                        throws IOException,
                                               AutomationException
The native transformation for the dimension graphic.

Remarks

If the current DimensionStyle supports text value conversion, the native units and transformation can be set with the NativeUnits and NativeTransformation properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setNativeTransformationByRef

void setNativeTransformationByRef(ITransformation transformation)
                                  throws IOException,
                                         AutomationException
The native transformation for the dimension graphic.

Remarks

If the current DimensionStyle supports text value conversion, the native units and transformation can be set with the NativeUnits and NativeTransformation properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.