com.esri.arcgis.controls
Interface IEngineEditProperties

All Superinterfaces:

Serializable

All Known Implementing Classes:

EngineEditor

public interface IEngineEditProperties
extends Serializable

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

Description

The IEngineEditProperties interface is used to manage all of the properties of an edit session.

Product Availability

Available with ArcGIS Engine.

Method Summary

int	getReportPrecision() Controls the number of decimal places the editor reports numbers with.
IMarkerSymbol	getSelectedVertexSymbol() Symbol used to draw the active vertex of the edit sketch.
ILineSymbol	getSketchSymbol() Symbol used to draw the lines of the edit sketch.
IMarkerSymbol	getSketchVertexSymbol() Symbol used to draw the vertices of the edit sketch.
IMarkerSymbol	getSnapSymbol() Symbol used to draw the snap location.
int	getStreamGroupingCount() Controls the number of points to group together when streaming.
double	getStreamTolerance() Controls the streaming tolerance, measured in map units.
ILayer	getTargetLayer() The editor's target layer.
boolean	isAutoSaveOnVersionRedefined() Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.
boolean	isStretchGeometry() Indicates if the edit sketch is stretched when one of its vertices is moved.
void	setAutoSaveOnVersionRedefined(boolean stretch) Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.
void	setReportPrecision(int numDecs) Controls the number of decimal places the editor reports numbers with.
void	setSelectedVertexSymbolByRef(IMarkerSymbol symbol) Symbol used to draw the active vertex of the edit sketch.
void	setSketchSymbolByRef(ILineSymbol symbol) Symbol used to draw the lines of the edit sketch.
void	setSketchVertexSymbolByRef(IMarkerSymbol symbol) Symbol used to draw the vertices of the edit sketch.
void	setSnapSymbolByRef(IMarkerSymbol symbol) Symbol used to draw the snap location.
void	setStreamGroupingCount(int tol) Controls the number of points to group together when streaming.
void	setStreamTolerance(double tol) Controls the streaming tolerance, measured in map units.
void	setStretchGeometry(boolean stretch) Indicates if the edit sketch is stretched when one of its vertices is moved.

Method Detail

getReportPrecision

int getReportPrecision()
                       throws IOException,
                              AutomationException

Controls the number of decimal places the editor reports numbers with.

Description

Use ReportPrecision to control the number of decimal places reported back from editing functions. By default ReportPrecision is set to 3.

Product Availability

Available with ArcGIS Engine.

Returns:

The numDecs

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportPrecision

void setReportPrecision(int numDecs)
                        throws IOException,
                               AutomationException

Controls the number of decimal places the editor reports numbers with.

Product Availability

Available with ArcGIS Engine.

Parameters:

numDecs - The numDecs (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStreamTolerance

double getStreamTolerance()
                          throws IOException,
                                 AutomationException

Controls the streaming tolerance, measured in map units.

Description

Use StreamTolerance to set the number of points that get added to a map (in map units) by the ControlsEditingSketchTool when in stream mode. By default StreamTolerance is 0.

Use the ControlsEditingSketchStreamingCommand to set the ControlsEditingSketchTool in stream mode.

Product Availability

Available with ArcGIS Engine.

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStreamTolerance

void setStreamTolerance(double tol)
                        throws IOException,
                               AutomationException

Controls the streaming tolerance, measured in map units.

Product Availability

Available with ArcGIS Engine.

Parameters:

tol - The tol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStreamGroupingCount

int getStreamGroupingCount()
                           throws IOException,
                                  AutomationException

Controls the number of points to group together when streaming.

Description

The StreamGroupingCount property controls how many grouped points are added to the undo stack by the ControlsEditingSketchTool when in stream mode. By default StreamGroupingCount is 50.

If StreamGroupingCount is 1 each streamed point added will be undoable and redoable. If the streaming tolerance is low, however, you may wish to make the grouping larger so that groups of added points can be undone or redone by the user with only one undo or redo.

Use the ControlsEditingSketchStreamingCommand to set the ControlsEditingSketchTool in stream mode.

Product Availability

Available with ArcGIS Engine.

Returns:

The tol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStreamGroupingCount

void setStreamGroupingCount(int tol)
                            throws IOException,
                                   AutomationException

Controls the number of points to group together when streaming.

Product Availability

Available with ArcGIS Engine.

Parameters:

tol - The tol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStretchGeometry

boolean isStretchGeometry()
                          throws IOException,
                                 AutomationException

Indicates if the edit sketch is stretched when one of its vertices is moved.

Description

StretchGeometry determines whether or not the edit sketch is stretched proportionally when a vertex is moved. By default StretchGeometryis false.

The following diagrams illustrate this point better. In both cases, the upper right vertex was moved.

Moving a vertex with StretchGeometry set to True:

Moving a vertex with StretchGeometry set to False:

Product Availability

Available with ArcGIS Engine.

Returns:

The stretch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStretchGeometry

void setStretchGeometry(boolean stretch)
                        throws IOException,
                               AutomationException

Indicates if the edit sketch is stretched when one of its vertices is moved.

Product Availability

Available with ArcGIS Engine.

Parameters:

stretch - The stretch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSketchSymbol

ILineSymbol getSketchSymbol()
                            throws IOException,
                                   AutomationException

Symbol used to draw the lines of the edit sketch.

Description

The SketchSymbol used for lines segments in the edit sketch. The default line symbol is a solid green line with a width of one.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.display.ILineSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSketchSymbolByRef

void setSketchSymbolByRef(ILineSymbol symbol)
                          throws IOException,
                                 AutomationException

Symbol used to draw the lines of the edit sketch.

Product Availability

Available with ArcGIS Engine.

Parameters:

symbol - A reference to a com.esri.arcgis.display.ILineSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSketchVertexSymbol

IMarkerSymbol getSketchVertexSymbol()
                                    throws IOException,
                                           AutomationException

Symbol used to draw the vertices of the edit sketch.

Description

The SketchVertexSymbol used for vertices in the edit sketch. Edit sketch vertices are drawn in green by default.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSketchVertexSymbolByRef

void setSketchVertexSymbolByRef(IMarkerSymbol symbol)
                                throws IOException,
                                       AutomationException

Symbol used to draw the vertices of the edit sketch.

Product Availability

Available with ArcGIS Engine.

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedVertexSymbol

IMarkerSymbol getSelectedVertexSymbol()
                                      throws IOException,
                                             AutomationException

Symbol used to draw the active vertex of the edit sketch.

Description

The SelectedVertexSymbol used for the last point (active point) in the edit sketch. By default this point is drawn in red and has a size of 4.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedVertexSymbolByRef

void setSelectedVertexSymbolByRef(IMarkerSymbol symbol)
                                  throws IOException,
                                         AutomationException

Symbol used to draw the active vertex of the edit sketch.

Product Availability

Available with ArcGIS Engine.

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapSymbol

IMarkerSymbol getSnapSymbol()
                            throws IOException,
                                   AutomationException

Symbol used to draw the snap location.

Description

The SnapSymbol displayed whenever you are working with the edit sketch. The default snap symbol is a blue dot.

The snap agent knows to draw the snap symbol twice, once to get rid of the old symbol and once to draw the symbol at its new location. When setting the symbol, don't forget to set the ISymbol::ROP2 to esriROPNotXOrPen. This setting allows the symbol to erase itself when drawn twice in the same location.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.display.IMarkerSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapSymbolByRef

void setSnapSymbolByRef(IMarkerSymbol symbol)
                        throws IOException,
                               AutomationException

Symbol used to draw the snap location.

Product Availability

Available with ArcGIS Engine.

Parameters:

symbol - A reference to a com.esri.arcgis.display.IMarkerSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoSaveOnVersionRedefined

boolean isAutoSaveOnVersionRedefined()
                                     throws IOException,
                                            AutomationException

Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.

Description

Auto reconciliation provides the user the ability to delay the save process for after the reconciliation. This allows the user to inspect the results of the reconciliation prior to saving. By default AutoSaveOnVersionRedefined is false.

If AutoSaveOnVersionRedefined is true, auto reconciliation will automatically reconcile the edit session with the version's current database state and save, making changes available to others using the database.

If AutoSaveOnVersionRedefined is false, when a save occurs, the edit session will be reconciled with the version's current database state, and then a message will inform the user that the edit session has been reconciled but has not been saved.

Product Availability

Available with ArcGIS Engine.

Returns:

The stretch

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoSaveOnVersionRedefined

void setAutoSaveOnVersionRedefined(boolean stretch)
                                   throws IOException,
                                          AutomationException

Indicates whether the stop editing process should automatically reconcile an edit session and save the version without notification.

Product Availability

Available with ArcGIS Engine.

Parameters:

stretch - The stretch (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetLayer

ILayer getTargetLayer()
                      throws IOException,
                             AutomationException

The editor's target layer.

Description

The target layer (or current layer) to be editied. For example, if the target layer is set to 'Buildings' any new features created will be part of the 'Buildings' layer.

The TargetLayer gets set when the end user interactively selects a layer using the ControlsEditingTargetToolControl.

Product Availability

Available with ArcGIS Engine.

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.