com.esri.arcgis.carto
Interface IDimensionShape

All Superinterfaces:
Serializable
All Known Implementing Classes:
DimensionShape

public interface IDimensionShape
extends Serializable

Provides access to members that control a dimension shape.

Description

The IDimensionShape interface supports properties for the definition of a dimensionís location and measurement.

Remarks

The BeginDimensionPoint and EndDimensionPoint properties define the Dimensionís measurement points. The DimensionLinePoint property determines the height of the dimension line above the baseline. To create a two point dimension, the DimensionLinePoint must be the same value as the BeginDimensionPoint. The ExtensionLineAngle property defines the angle between the dimension line and the extension line in degrees. This default angle is 90 degrees. Oblique dimensions have angles less than or greater than 90 degrees. The DimensionShape also supports a custom text location using the TextPoint property. For the default location of the dimension text, the TextPointís IGeometry::IsEmpty property should be True.

The TextAngle property is the angle of the text in radians. The TextAngle property will only affect the dimension if the dimension's style's text alignment property is True in which case the text is always parallel to the dimension line.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IPoint getBeginDimensionPoint()
          The begin dimension point.
 IPoint getDimensionLinePoint()
          The point which describes the height of the dimension line.
 IPoint getEndDimensionPoint()
          The end dimension point.
 double getExtensionLineAngle()
          The angle of the extension lines in radians.
 double getTextAngle()
          The angle of the text in radians.
 IPoint getTextPoint()
          The point for the text placement.
 void setBeginDimensionPointByRef(IPoint point)
          The begin dimension point.
 void setDimensionLinePointByRef(IPoint point)
          The point which describes the height of the dimension line.
 void setEndDimensionPointByRef(IPoint point)
          The end dimension point.
 void setExtensionLineAngle(double angle)
          The angle of the extension lines in radians.
 void setTextAngle(double angle)
          The angle of the text in radians.
 void setTextPointByRef(IPoint point)
          The point for the text placement.
 

Method Detail

setBeginDimensionPointByRef

void setBeginDimensionPointByRef(IPoint point)
                                 throws IOException,
                                        AutomationException
The begin dimension point.

Remarks

The BeginDimensionPoint and EndDimensionPoint properties define the Dimensionís measurement points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getBeginDimensionPoint

IPoint getBeginDimensionPoint()
                              throws IOException,
                                     AutomationException
The begin dimension point.

Remarks

The BeginDimensionPoint and EndDimensionPoint properties define the Dimensionís measurement points.

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.

setEndDimensionPointByRef

void setEndDimensionPointByRef(IPoint point)
                               throws IOException,
                                      AutomationException
The end dimension point.

Remarks

The BeginDimensionPoint and EndDimensionPoint properties define the Dimensionís measurement points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getEndDimensionPoint

IPoint getEndDimensionPoint()
                            throws IOException,
                                   AutomationException
The end dimension point.

Remarks

The BeginDimensionPoint and EndDimensionPoint properties define the Dimensionís measurement points.

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.

getDimensionLinePoint

IPoint getDimensionLinePoint()
                             throws IOException,
                                    AutomationException
The point which describes the height of the dimension line.

Remarks

The DimensionLinePoint property determines the height of the dimension line above the baseline. To create a two point dimension, the DimensionLinePoint must be the same value as the BeginDimensionPoint.

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.

setDimensionLinePointByRef

void setDimensionLinePointByRef(IPoint point)
                                throws IOException,
                                       AutomationException
The point which describes the height of the dimension line.

Remarks

The DimensionLinePoint property determines the height of the dimension line above the baseline. To create a two point dimension, the DimensionLinePoint must be the same value as the BeginDimensionPoint.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTextPoint

IPoint getTextPoint()
                    throws IOException,
                           AutomationException
The point for the text placement.

Remarks

The DimensionShape supports a custom text location using the TextPoint property. For the default location of the dimension text, the TextPointís IGeometry::IsEmpty property should be True.

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.

setTextPointByRef

void setTextPointByRef(IPoint point)
                       throws IOException,
                              AutomationException
The point for the text placement.

Remarks

The DimensionShape supports a custom text location using the TextPoint property. For the default location of the dimension text, the TextPointís IGeometry::IsEmpty property should be True.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getExtensionLineAngle

double getExtensionLineAngle()
                             throws IOException,
                                    AutomationException
The angle of the extension lines in radians.

Remarks

The ExtensionLineAngle property defines the angle between the dimension line and the extension line in degrees. This default angle is 90 degrees. Oblique dimensions have angles less than or greater than 90 degrees.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExtensionLineAngle

void setExtensionLineAngle(double angle)
                           throws IOException,
                                  AutomationException
The angle of the extension lines in radians.

Remarks

The ExtensionLineAngle property defines the angle between the dimension line and the extension line in degrees. This default angle is 90 degrees. Oblique dimensions have angles less than or greater than 90 degrees.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTextAngle

double getTextAngle()
                    throws IOException,
                           AutomationException
The angle of the text in radians.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setTextAngle

void setTextAngle(double angle)
                  throws IOException,
                         AutomationException
The angle of the text in radians.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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