com.esri.arcgis.editor
Interface IEditProperties2

All Superinterfaces:

Serializable

All Known Implementing Classes:

Editor, IEditProperties2Proxy

public interface IEditProperties2
extends Serializable

Provides access to more members that control the properties of an edit session.

Remarks

The IEditProperties2 interface provides additional parameters to control the editor's behavior.

Product Availability

Available with ArcGIS Desktop.

Method Summary

double	getAngularCorrectionOffset() Angular Correction Offset.
int	getAngularUnitPrecision() Precision used to display angular units.
int	getDirectionType() Direction Type.
int	getDirectionUnits() Direction Units.
double	getDistanceCorrectionFactor() Distance Correction Factor.
int	getStickyMoveTolerance() Controls the sticky move tolerance.
boolean	isSnapTips() Indicates whether to show the snap tips.
boolean	isUseGroundToGrid() Indicates whether to use Ground to Grid.
void	setAngularCorrectionOffset(double angOffset) Angular Correction Offset.
void	setAngularUnitPrecision(int auPrecision) Precision used to display angular units.
void	setDirectionType(int dirType) Direction Type.
void	setDirectionUnits(int dirUnits) Direction Units.
void	setDistanceCorrectionFactor(double distFactor) Distance Correction Factor.
void	setSnapTips(boolean tips) Indicates whether to show the snap tips.
void	setStickyMoveTolerance(int tol) Controls the sticky move tolerance.
void	setUseGroundToGrid(boolean g2g) Indicates whether to use Ground to Grid.

Method Detail

getStickyMoveTolerance

int getStickyMoveTolerance()
                           throws IOException,
                                  AutomationException

Controls the sticky move tolerance.

Remarks

StickyMoveTolerance determines the minimum distance (measured in pixels) the cursor must move before the edit is completed. This can be helpful in preventing small inadvertent shifts of features when editing. The default value is 0.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStickyMoveTolerance

void setStickyMoveTolerance(int tol)
                            throws IOException,
                                   AutomationException

Controls the sticky move tolerance.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

tol - The tol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSnapTips

boolean isSnapTips()
                   throws IOException,
                          AutomationException

Indicates whether to show the snap tips.

Remarks

Use this property to determine whether snap tips are displayed when snapping is used in the editor. Snap tips provide feedback in the form of a tool tip and a message in the status bar identifying the snap agent that was used to modify the current point. If the snap agent used is a feature snap agent, the layer name and hit type are displayed; otherwise the snap agent name is displayed.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The tips

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapTips

void setSnapTips(boolean tips)
                 throws IOException,
                        AutomationException

Indicates whether to show the snap tips.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

tips - The tips (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngularUnitPrecision

void setAngularUnitPrecision(int auPrecision)
                             throws IOException,
                                    AutomationException

Precision used to display angular units.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

auPrecision - The auPrecision (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngularUnitPrecision

int getAngularUnitPrecision()
                            throws IOException,
                                   AutomationException

Precision used to display angular units.

Remarks

AngularUnitPrecision determines the number of digits displayed after the decimal place. The default is 4.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The auPrecision

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionType

void setDirectionType(int dirType)
                      throws IOException,
                             AutomationException

Direction Type.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

dirType - A com.esri.arcgis.system.esriDirectionType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionType

int getDirectionType()
                     throws IOException,
                            AutomationException

Direction Type.

Remarks

IEditProperties::DirectionType determines the method of measurement for direction values. The default value is esriDTPolar.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.system.esriDirectionType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirectionUnits

void setDirectionUnits(int dirUnits)
                       throws IOException,
                              AutomationException

Direction Units.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

dirUnits - A com.esri.arcgis.system.esriDirectionUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirectionUnits

int getDirectionUnits()
                      throws IOException,
                             AutomationException

Direction Units.

Remarks

The direction units define how angles are specified; how many parts a complete circle is divided into and how to interpret the angle value entered. The default value is esriDUDecimalDegrees.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.system.esriDirectionUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDistanceCorrectionFactor

void setDistanceCorrectionFactor(double distFactor)
                                 throws IOException,
                                        AutomationException

Distance Correction Factor.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

distFactor - The distFactor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDistanceCorrectionFactor

double getDistanceCorrectionFactor()
                                   throws IOException,
                                          AutomationException

Distance Correction Factor.

Remarks

Use this property to determine the distance amount applied when length measurements are input into the editor. The value may be accessed or modified at any time; however, it is applied only when IEditProperties::UseGroundToGrid is set to True. The default value is 0 (no correction).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The distFactor

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAngularCorrectionOffset

void setAngularCorrectionOffset(double angOffset)
                                throws IOException,
                                       AutomationException

Angular Correction Offset.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

angOffset - The angOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAngularCorrectionOffset

double getAngularCorrectionOffset()
                                  throws IOException,
                                         AutomationException

Angular Correction Offset.

Remarks

AngularCorrectionOffset determines the amount of correction applied to each entered angular value. The offset is specified in radians. This property may be accessed at any time; it is only applied when the IEditProperties2::UseGroundToGrid is True. The default value is 0 (no correction).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The angOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseGroundToGrid

void setUseGroundToGrid(boolean g2g)
                        throws IOException,
                               AutomationException

Indicates whether to use Ground to Grid.

Remarks

Use this property to control whether any distance or direction offsets are applied to angle or length values respectively when using the editor. If UseGroundToGrid is True then the distance offset specified by IEditProperties2::DistanceCorrectionFactor and the angular offset specified by IEditProperties2::AngularCorrectionFactor are used.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

g2g - The g2g (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseGroundToGrid

boolean isUseGroundToGrid()
                          throws IOException,
                                 AutomationException

Indicates whether to use Ground to Grid.

Remarks

Use this property to control whether any distance or direction offsets are applied to angle or length values respectively when using the editor. If UseGroundToGrid is True then the distance offset specified by IEditProperties2::DistanceCorrectionFactor and the angular offset specified by IEditProperties2::AngularCorrectionFactor are used.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The g2g

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.