com.esri.arcgis.editor
Interface IEditSketch

All Superinterfaces:

Serializable

All Known Subinterfaces:

IEditSketch2, IEditSketch3

All Known Implementing Classes:

Editor, IEditSketch2Proxy, IEditSketch3Proxy, IEditSketchProxy

public interface IEditSketch
extends Serializable

Provides access to members that access and manipulate the edit sketch.

Superseded By

IEditSketch3

Remarks

The IEditSketch interface is on the Editor CoClass.

Edit tasks set the geometry type of the edit sketch, and the sketch tools add points to that geometry. For example, the Create New Feature task sets the edit sketch geometry type to be the same as the geometry type of the target layer. In contrast, the Select Features Using a Line task always sets the edit sketch geometry type to esriGeometryPolyline, with no regard to the current layer geometry type.

Edit tasks often set the edit sketch geometry to esriGeometryNull, causing the sketch tools to become inactive. For example, the Reshape task will set the edit sketch geometry to esriGeometryNull if there are no polygon or polyline features selected. This prevents users from creating an edit sketch that would otherwise do nothing. Edit tasks respond to editor events such as OnSelectionChanged and OnCurrentLayerChanged to accomplish this.

When To Use

The purpose of the IEditSketch interface is to manage a geometry that will be used extensively by the editor. Ultimately, the editor's current task takes the geometry to perform some action; for example, the CreateNewFeature task takes the geometry and stores it in the database as a new feature.

The editor automatically creates a new empty geometry. The type of geometry created is the same as the editor's current layer (IEditor::CurrentLayer ). Use the AddPoint method to build (add data to) the edit sketch geometry and FinishSketch to signal the current task that the geometry is ready for use. To bring an existing feature into the edit sketch, set the Geometry property to the desired feature and call RefreshSketch .

Product Availability

Available with ArcGIS Desktop.

See Also:

ISnapEnvironment, IEditProperties, IFeatureClass.getShapeType(), IEditTask.activate(com.esri.arcgis.editor.IEditor, com.esri.arcgis.editor.IEditTask), IEditor, IGeometry, IEditLayers, IEditTask.deactivate(), IEditAttributeProperties, IEditEvents2, IEditTask.onFinishSketch(), IDatasetEdit, IDatasetEditInfo, IEditTask.onDeleteSketch(), IEditTask.getName(), IEditEvents, Editor, esriGeometryType, IEditSketch

Method Summary

void	addPoint(IPoint point, boolean allowUndo) Adds a point to the edit sketch.
void	finishSketch() Completes the current edit sketch.
void	finishSketchPart() Completes a part for the current edit sketch.
IGeometry	getGeometry() Geometry stored in the edit sketch.
int	getGeometryType() Type of the geometry stored in the edit sketch.
IPoint	getLastPoint() The last point in the edit sketch.
int	getPart() The index of the current part of the sketch.
int	getSegment() The index of the current segment of the sketch.
int	getVertex() The index of the current vertex of the sketch.
void	modifySketch() Call to notify listeners that the sketch has been changed.
void	refreshSketch() Invalidates the portion of the display that is occupied by the sketch.
void	setGeometryByRef(IGeometry geometry) Geometry stored in the edit sketch.
void	setGeometryType(int geomType) Type of the geometry stored in the edit sketch.

Method Detail

getPart

int getPart()
            throws IOException,
                   AutomationException

The index of the current part of the sketch.

Remarks

You must right-click on the desired part of the edit sketch to set this property correctly. The wrong part index will be returned if you do not right-click on the desired part beforehand. For example, if an edit sketch has two parts, Part will always return a 0 (all sketches have at least one part) until you right click on the second part.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The part

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEditSketch.getSegment(), IEditSketch.getVertex()

getSegment

int getSegment()
               throws IOException,
                      AutomationException

The index of the current segment of the sketch.

Remarks

You must right-click on the desired segment in the edit sketch to set this property correctly. The wrong segment index will be returned if you do not right-click on the desired segment beforehand. A value of -1 indicates no segment has been selected. For example, if your last right-click was on an edit sketch vertex, the Segment property will return a value of -1.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The segment

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEditSketch.getVertex(), IEditSketch.getPart()

getVertex

int getVertex()
              throws IOException,
                     AutomationException

The index of the current vertex of the sketch.

Remarks

You must right-click on the desired vertex in the edit sketch to set this property correctly. The wrong vertex index will be returned if you do not right-click on the desired vertex beforehand. A value of -1 means no vertex has been selected. For example, if your last right-click was on a segment in the edit sketch, the Vertex property will be set to -1.

Use Part, Segment and Vertex when creating custom commands for the sketch context menu. For example, to delete a vertex in the edit sketch, right-click on the vertex to retrieve its index and call IPointCollection::RemovePoints .

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The vertex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEditSketch.getSegment(), IEditSketch.getPart()

getGeometryType

int getGeometryType()
                    throws IOException,
                           AutomationException

Type of the geometry stored in the edit sketch.

Remarks

Use this property in conjunction with the Geometry property to manage the geometry inside the edit sketch. Valid geometry types are: esriGeometryPoint , esriGeometryPolygon , esriGeometryPolyline and esriGeometryNull . Setting GeometryType automatically initializes the Geometry property and vice versa. For example, if you set the GeometryType to esriGeometryPolygon, a new empty Polygon object will b e created.

When To Use

Use this property to control actions on the edit sketch based on geometry type. For example, you may have code that draws a rubberband between the current mouse location and the edit sketch's last point if the geometry type is not point.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryType

void setGeometryType(int geomType)
                     throws IOException,
                            AutomationException

Type of the geometry stored in the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

geomType - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry()
                      throws IOException,
                             AutomationException

Geometry stored in the edit sketch.

Remarks

This property sets the geometry the editor works with, ultimately passing it to the current task. By default, the editor creates a new empty geometry for you, and it does this any time you change the editor's current layer (IEditLayers::SetCurrentLayer ), reset the GeometryType property, or complete a task with a previous geometry. Because of this behavior, there is generally no need to set the Geometry property when you are building new geometries from scratch. Do set the Geometry property when you want to bring an existing feature into the edit sketch.

Valid geometry types are: esriGeometryPoint , esriGeometryMultipoint, esriGeometryPolyline and esriGeometryPolygon .

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

void setGeometryByRef(IGeometry geometry)
                      throws IOException,
                             AutomationException

Geometry stored in the edit sketch.

Description

This property sets the geometry an EditSketch holds and works with. When working with the Editor object created and managed by MapStudio, the EditSketch by default hold s a new empty geometry (Mulitpoint , Polyline or Polygon) determined by CurrentLayer. Use the empty geometry when building new geometries; for example, when adding a new parcel to a parcels layer. To modify an existing feature, do not use the default geometry; instead, set Geometry to the desired feature and this will bring it into the EditSketch. Note: manually setting Geometry also sets GeometryType accordingly and vice versa. Each Task performs a different action involving the geometry when FinishSketch is called.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addPoint

void addPoint(IPoint point,
              boolean allowUndo)
              throws IOException,
                     AutomationException

Adds a point to the edit sketch. If allowUndo is true, a new operation will be created.

Remarks

Use the AddPoint method to build the geometry held in the edit sketch. The required point parameter specifies the location of the next point in the sketch. In all cases, new segments are added linking the edit sketch to the provided point, except where the geometry type is set to Point or the point represents the very first point in the edit sketch.


In the above illustration, a new segment is added to a Polyline using the AddPoint method.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

point - A reference to a com.esri.arcgis.geometry.IPoint (in)

allowUndo - The allowUndo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshSketch

void refreshSketch()
                   throws IOException,
                          AutomationException

Invalidates the portion of the display that is occupied by the sketch.

Description

Refreshes only the portion of the screen falling within the edit sketch's slightly expanded envelope (IGeometry::Envelope).

Remarks

Sometimes it may be necessary to invalidate a larger portion of the display in order to get rid of unwanted artifacts. This situation can arise when you shorten the length of a segment for example. Since the new geometry is shorter and calling RefreshSketch only refreshes the area within the envelope of the geometry, old data may still be erroneously displayed outside of this boundary. See the documentation for the InvalidArea object for more details.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

finishSketch

void finishSketch()
                  throws IOException,
                         AutomationException

Completes the current edit sketch.

Remarks

This function completes the edit sketch by notifying the editor's current task of this event. FinishSketch also calls RefreshSketch and IEditEvents::OnSketchFinished .

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

finishSketchPart

void finishSketchPart()
                      throws IOException,
                             AutomationException

Completes a part for the current edit sketch.

Remarks

Call this function to create multi-part geometries.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastPoint

IPoint getLastPoint()
                    throws IOException,
                           AutomationException

The last point in the edit sketch.

Remarks

Use this property to retrieve the last point in the edit sketch.

When To Use

The last point is often used as an anchor when drawing a rubber-band (line) between the EditSketch and the current mouse location.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

modifySketch

void modifySketch()
                  throws IOException,
                         AutomationException

Call to notify listeners that the sketch has been changed.

Remarks

Generates an event signaling that the EditSketch has been modified. Listen for this event using IEditEvents::OnSketchModified .

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.