com.esri.arcgis.carto
Interface IDimensionClassExtension

All Superinterfaces:

Serializable

All Known Implementing Classes:

DimensionClassExtension

public interface IDimensionClassExtension
extends Serializable

Provides access to members that control the dimension class extension for a dimension feature class.

Description

The IDimensionClassExtension interface provides access to the DimensionStyles collection and the reference scale drawing properties.

Remarks

After making changes to any of the IDimensionClassExtension properties, it is necessary to call the UpdateProperties() method. Changes can also be discarded by calling the ResetProperties() method if UpdateProperties() has not be called. As with any schema related modifications, an exclusive schema lock should be obtained on the feature class before calling UpdateProperties().

Product Availability

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

Method Summary

IDimensionStyles	getDimensionStyles() The collection of dimension styles associated with the dimension feature class.
ITransformation	getNativeTransformation() The native display transformation of the dimension feature class.
double	getReferenceScale() The reference scale of the dimension feature class.
int	getReferenceScaleUnits() The reference scale units of the dimension feature class.
void	resetProperties() Resets the in state of the dimension feature class properties.
void	setReferenceScale(double scale) The reference scale of the dimension feature class.
void	setReferenceScaleUnits(int units) The reference scale units of the dimension feature class.
void	updateProperties() Updates the dimension featrue class' properties.

Method Detail

getDimensionStyles

IDimensionStyles getDimensionStyles()
                                    throws IOException,
                                           AutomationException

The collection of dimension styles associated with the dimension feature class.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

updateProperties

void updateProperties()
                      throws IOException,
                             AutomationException

Updates the dimension featrue class' properties.

Remarks

As with any schema related modifications, an exclusive schema lock should be obtained on the feature class before calling UpdateProperties().

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetProperties

void resetProperties()
                     throws IOException,
                            AutomationException

Resets the in state of the dimension feature class properties.

Remarks

As with any schema related modifications, an exclusive schema lock should be obtained on the feature class before calling ResetProperties().

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScale

double getReferenceScale()
                         throws IOException,
                                AutomationException

The reference scale of the dimension feature class.

Remarks

The ReferenceScale property defines the scale at which symbols are drawn at their defined size. The ReferenceScaleUnits property is only used when the Dimension FeatureClass’s spatial reference is Unknown. Changing the ReferenceScale after the FeatureClass contains Features is not recommend as those Features’ geometries are controlled by the ReferenceScale property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The scale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReferenceScale

void setReferenceScale(double scale)
                       throws IOException,
                              AutomationException

The reference scale of the dimension feature class.

Remarks

The ReferenceScale property defines the scale at which symbols are drawn at their defined size. Changing the ReferenceScale after the FeatureClass contains Features is not recommend as those Features’ geometries are controlled by the ReferenceScale property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

scale - The scale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReferenceScaleUnits

int getReferenceScaleUnits()
                           throws IOException,
                                  AutomationException

The reference scale units of the dimension feature class.

Remarks

The ReferenceScaleUnits property is only used when the Dimension FeatureClass’s spatial reference is Unknown.

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.

setReferenceScaleUnits

void setReferenceScaleUnits(int units)
                            throws IOException,
                                   AutomationException

The reference scale units of the dimension feature class.

Remarks

The ReferenceScaleUnits property is only used when the Dimension FeatureClass’s spatial reference is Unknown.

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.

getNativeTransformation

ITransformation getNativeTransformation()
                                        throws IOException,
                                               AutomationException

The native display transformation of the dimension feature class.

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.