com.esri.arcgis.editor
Interface IDimensionEditExtension

All Superinterfaces:

Serializable

All Known Implementing Classes:

DimensionEditExtension

public interface IDimensionEditExtension
extends Serializable

Provides access to members that control dimension feature editing.

Product Availability

Available with ArcGIS Desktop.

Method Summary

int	getCreateStyleID() The style id of newly created dimension features.
IEnumDimensionConstructor	getDimensionConstructors() The dimension constructors for creating new dimensions.
IEditor	getEditor() The editor application extension.
boolean	isDimensionTarget() Indicates if a dimension feature class is the current editor target.
void	setCreateStyleID(int styleID) The style id of newly created dimension features.
void	setCurrentConstructorByRef(IDimensionConstructor rhs1) The currently selected dimension constructor.

Method Detail

getCreateStyleID

int getCreateStyleID()
                     throws IOException,
                            AutomationException

The style id of newly created dimension features.

Remarks

Each Dimension Style has a unique ID value within a dimension feature class. A dimension style is used each time a new dimension feature is created. The style used for the creation of the feature is determined using CreateStyleID property.

When an invalid CreateStyleID value is set, CreateStyleID returns -1.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The styleID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCreateStyleID

void setCreateStyleID(int styleID)
                      throws IOException,
                             AutomationException

The style id of newly created dimension features.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

styleID - The styleID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDimensionConstructors

IEnumDimensionConstructor getDimensionConstructors()
                                                   throws IOException,
                                                          AutomationException

The dimension constructors for creating new dimensions.

Remarks

Returns the current dimension constructors under the component category 'ESRI Dimension Constructors', returning them in an IEnumDimensionConstructor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.editor.IEnumDimensionConstructor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentConstructorByRef

void setCurrentConstructorByRef(IDimensionConstructor rhs1)
                                throws IOException,
                                       AutomationException

The currently selected dimension constructor.

Remarks

Sets the DimensionConstructor used to create new dimension features. A reference to an DimensionConstructor is often acquired by obtaining a reference to IEnumDimensionConstructor and looping through until the desired constructor is returned.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - A reference to a com.esri.arcgis.editor.IDimensionConstructor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDimensionTarget

boolean isDimensionTarget()
                          throws IOException,
                                 AutomationException

Indicates if a dimension feature class is the current editor target.

Remarks

Determines if the editor's target layer is a dimension feature class.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The isDimension

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEditor

IEditor getEditor()
                  throws IOException,
                         AutomationException

The editor application extension.

Remarks

Use the Editor to provide quick access the ArcMap Editor. This is particularly useful to QI to Editor::IEditLayers to get the IEditLayers::CurrentLayer. Once you have the CurrentLayer you can access its DimensionClassExtension to retrieve IDimensionClassExtension::ReferenceScaleUnits and IDimensionClassExtension::ReferenceScale. These properties are helpful when building a custom dimension constructor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.editor.IEditor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.