com.esri.arcgis.carto
Interface IDimensionFeature

All Superinterfaces:
Serializable
All Known Implementing Classes:
DimensionFeature

public interface IDimensionFeature
extends Serializable

Provides access to members that control a dimension feature.

Description

The IDimensionFeature interface provides properties for setting the style and placement of a DimensionFeature.

Remarks

The StyleID property should be a valid ID from the class’s DimensionStyles collection. If the current ID is invalid, the DimensionFeature will draw its boundary in red. The DimensionShape property defines the placement of the elements of a DimensionFeature. The location and size of the DimensionFeature is determined entirely by the DimensionShape and it is not necessary to use the IFeature::Shape property. The DimensionType property defines the type of the Dimension as Linear or Aligned and affects how the EditTool behaves with the DimensionFeature during shape modification. The DimensionLineDisplay, ExtensionLineDisplay, and MarkerDisplay properties are values that override the values of the current DimensionStyle. A custom value for the DimensionFeature’s text can be set using the CustomLength property and by setting the UseCustomLength property to True.

Example:

  

// This example assumes a reference to an IdimensionFeature (pDimensionFeature)…
IDimensionFeature pDimensionFeature = null;   
pDimensionFeature.setCustomLength(5.5);   
pDimensionFeature.setUseCustomLength(true);   
IFeature pFeature = new IFeatureProxy(pDimensionFeature);   
pFeature.store();

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getCustomLength()
          The dimension feature's custom or user-defined length.
 int getDimensionLineDisplay()
          The dimension line display for the feature.
 IDimensionShape getDimensionShape()
          The dimension feature's shape.
 int getDimensionType()
          The dimension type of the feature.
 int getExtensionLineDisplay()
          The extension line display of the feature.
 double getLength()
          The dimension feature's length.
 int getMarkerDisplay()
          The arrow display of the feature.
 int getStyleID()
          The dimension feature's style Id.
 boolean isUseCustomLength()
          Indicates if this dimension feature displays the dimension length or a custom length.
 void setCustomLength(double length)
          The dimension feature's custom or user-defined length.
 void setDimensionLineDisplay(int displayOption)
          The dimension line display for the feature.
 void setDimensionShape(IDimensionShape shape)
          The dimension feature's shape.
 void setDimensionType(int type)
          The dimension type of the feature.
 void setExtensionLineDisplay(int displayOption)
          The extension line display of the feature.
 void setMarkerDisplay(int displayOption)
          The arrow display of the feature.
 void setStyleID(int iD)
          The dimension feature's style Id.
 void setUseCustomLength(boolean use)
          Indicates if this dimension feature displays the dimension length or a custom length.
 

Method Detail

setDimensionShape

void setDimensionShape(IDimensionShape shape)
                       throws IOException,
                              AutomationException
The dimension feature's shape.

Remarks

The DimensionShape property defines the placement of the elements of a DimensionFeature. The location and size of the DimensionFeature is determined entirely by the DimensionShape and it is not necessary to use the IFeature::Shape property.

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 dimension feature's shape.

Remarks

The DimensionShape property defines the placement of the elements of a DimensionFeature. The location and size of the DimensionFeature is determined entirely by the DimensionShape and it is not necessary to use the IFeature::Shape property.

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.

getStyleID

int getStyleID()
               throws IOException,
                      AutomationException
The dimension feature's style Id.

Remarks

The StyleID property should be a valid ID from the class’s DimensionStyles collection. If the current ID is invalid, the DimensionFeature will draw its boundary in red.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setStyleID

void setStyleID(int iD)
                throws IOException,
                       AutomationException
The dimension feature's style Id.

Remarks

The StyleID property should be a valid ID from the class’s DimensionStyles collection. If the current ID is invalid, the DimensionFeature will draw its boundary in red.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLength

double getLength()
                 throws IOException,
                        AutomationException
The dimension feature's length.

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 dimension feature's custom or user-defined length.

Remarks

A custom value for the DimensionFeature’s text can be set using the CustomLength property and by setting the UseCustomLength property to True.

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 dimension feature's custom or user-defined length.

Remarks

A custom value for the DimensionFeature’s text can be set using the CustomLength property and by setting the UseCustomLength property to True.

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 this dimension feature displays the dimension length or a custom length.

Remarks

A custom value for the DimensionFeature’s text can be set using the CustomLength property and by setting the UseCustomLength property to True.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUseCustomLength

void setUseCustomLength(boolean use)
                        throws IOException,
                               AutomationException
Indicates if this dimension feature displays the dimension length or a custom length.

Remarks

A custom value for the DimensionFeature’s text can be set using the CustomLength property and by setting the UseCustomLength property to True.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setDimensionLineDisplay

void setDimensionLineDisplay(int displayOption)
                             throws IOException,
                                    AutomationException
The dimension line display for the feature.

Remarks

The DimensionLineDisplay, ExtensionLineDisplay, and MarkerDisplay properties are values that override the values of the current DimensionStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

int getDimensionLineDisplay()
                            throws IOException,
                                   AutomationException
The dimension line display for the feature.

Remarks

The DimensionLineDisplay, ExtensionLineDisplay, and MarkerDisplay properties are values that override the values of the current DimensionStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExtensionLineDisplay

void setExtensionLineDisplay(int displayOption)
                             throws IOException,
                                    AutomationException
The extension line display of the feature.

Remarks

The DimensionLineDisplay, ExtensionLineDisplay, and MarkerDisplay properties are values that override the values of the current DimensionStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

int getExtensionLineDisplay()
                            throws IOException,
                                   AutomationException
The extension line display of the feature.

Remarks

The DimensionLineDisplay, ExtensionLineDisplay, and MarkerDisplay properties are values that override the values of the current DimensionStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMarkerDisplay

void setMarkerDisplay(int displayOption)
                      throws IOException,
                             AutomationException
The arrow display of the feature.

Remarks

The DimensionLineDisplay, ExtensionLineDisplay, and MarkerDisplay properties are values that override the values of the current DimensionStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

int getMarkerDisplay()
                     throws IOException,
                            AutomationException
The arrow display of the feature.

Remarks

The DimensionLineDisplay, ExtensionLineDisplay, and MarkerDisplay properties are values that override the values of the current DimensionStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDimensionType

int getDimensionType()
                     throws IOException,
                            AutomationException
The dimension type of the feature.

Remarks

The DimensionType property defines the type of the Dimension as Linear or Aligned and affects how the EditTool behaves with the DimensionFeature during shape modification.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.esriDimensionType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDimensionType

void setDimensionType(int type)
                      throws IOException,
                             AutomationException
The dimension type of the feature.

Remarks

The DimensionType property defines the type of the Dimension as Linear or Aligned and affects how the EditTool behaves with the DimensionFeature during shape modification.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
type - A com.esri.arcgis.carto.esriDimensionType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.