com.esri.arcgis.editor
Interface IEditSketch2

All Superinterfaces:

IEditSketch, Serializable

All Known Subinterfaces:

IEditSketch3

All Known Implementing Classes:

Editor, IEditSketch2Proxy, IEditSketch3Proxy

public interface IEditSketch2
extends IEditSketch, Serializable

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

Superseded By

IEditSketch2

Remarks

The IEditSketch2 interface is on the Editor CoClass.

When To Use

IEditSketch2 extends the functionality of the edit sketch by adding support for making the sketch z-aware and for setting Z values on a vertex as well as managing the current EditSketchExtension. IEditSketch2 also has three functions that fire event notifications when vertices are added, modified, or deleted. For example, whenever a vertex is deleted from an edit sketch, VertexDeleted should be called so that any clients listening for this event can respond.

Product Availability

Available with ArcGIS Desktop.

Method Summary

double	getCurrentZ() Current Z value for the edit sketch.
IEditSketchExtension	getEditSketchExtension() The current edit sketch extension.
boolean	isMAware() Indicates if the edit sketch geometry will contain Ms.
boolean	isPartComplete() Indicates whether FinishPart has been called on the edit sketch.
boolean	isZAware() Indicates if the edit sketch geometry will contain Zs.
void	setCurrentZ(double z) Current Z value for the edit sketch.
void	setEditSketchExtensionByRef(IEditSketchExtension extension) The current edit sketch extension.
void	setMAware(boolean aware) Indicates if the edit sketch geometry will contain Ms.
void	setZAware(boolean aware) Indicates if the edit sketch geometry will contain Zs.
void	vertexAdded(IPoint point) Call to notify listeners that a sketch vertex has been added.
void	vertexDeleted(IPoint point) Call to notify listeners that a sketch vertex has been deleted.
void	vertexMoved(IPoint point) Call to notify listeners that a sketch vertex has been moved.

Methods inherited from interface com.esri.arcgis.editor.IEditSketch

addPoint, finishSketch, finishSketchPart, getGeometry, getGeometryType, getLastPoint, getPart, getSegment, getVertex, modifySketch, refreshSketch, setGeometryByRef, setGeometryType

Method Detail

isZAware

boolean isZAware()
                 throws IOException,
                        AutomationException

Indicates if the edit sketch geometry will contain Zs.

Remarks

If the EditSketch geometry contains elevation (z) values, the ZAware property will return a boolean value of True.

To view the z values for the edit sketch right click over a sketch segment and display the edit sketch properties dialog. If the sketch is ZAware, an additional column will appear next to the y column showing the z values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The aware

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZAware

void setZAware(boolean aware)
               throws IOException,
                      AutomationException

Indicates if the edit sketch geometry will contain Zs.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

aware - The aware (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentZ

double getCurrentZ()
                   throws IOException,
                          AutomationException

Current Z value for the edit sketch.

Remarks

The CurrentZ property returns or sets the Z value that is applied to all points added to the sketch.

To view the z values for the edit sketch right click over a sketch segment and display the properties dialog. If the sketch is ZAware, an additional column will appear next to the y column showing the z values.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The z

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentZ

void setCurrentZ(double z)
                 throws IOException,
                        AutomationException

Current Z value for the edit sketch.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

z - The z (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEditSketchExtensionByRef

void setEditSketchExtensionByRef(IEditSketchExtension extension)
                                 throws IOException,
                                        AutomationException

The current edit sketch extension.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

extension - A reference to a com.esri.arcgis.editor.IEditSketchExtension (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEditSketchExtension

IEditSketchExtension getEditSketchExtension()
                                            throws IOException,
                                                   AutomationException

The current edit sketch extension.

Remarks

Returns the current edit sketch extension. Dimensions and Geodatabase annotation features utilize edit sketch extensions when creating and modifying their geometry.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

vertexAdded

void vertexAdded(IPoint point)
                 throws IOException,
                        AutomationException

Call to notify listeners that a sketch vertex has been added.

Remarks

When IEditSketch2::VertexAdded is called, all clients listening to IEditEvents2::OnVertexAdded are notified. This may be used to ensure the maximum number of points in a particular sketch is not exceeded.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

vertexDeleted

void vertexDeleted(IPoint point)
                   throws IOException,
                          AutomationException

Call to notify listeners that a sketch vertex has been deleted.

Remarks

When IEditSketch2::VertexDeleted is called, all clients listening to IEditEvents2::OnVertexDeleted are notified. This may be used to ensure the minimum number of points in a particular sketch is not exceeded.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

vertexMoved

void vertexMoved(IPoint point)
                 throws IOException,
                        AutomationException

Call to notify listeners that a sketch vertex has been moved.

Remarks

When IEditSketch2::VertexMoved is called, all clients listening to IEditEvents2::OnVertexMoved are notified.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isMAware

boolean isMAware()
                 throws IOException,
                        AutomationException

Indicates if the edit sketch geometry will contain Ms.

Remarks

If the EditSketch geometry contains measures (Ms), the MAware property will return a boolean value of True.

To view the m values for the edit sketch right click over a sketch segment and display the properties dialog. If the sketch is MAware, an additional column will appear to the right showing the m values.

If the edit sketch is m-aware, all newly inserted vertices will have a value of NaN. Inserting an m-aware sketch into a feature that is not m-aware will return an error.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The aware

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMAware

void setMAware(boolean aware)
               throws IOException,
                      AutomationException

Indicates if the edit sketch geometry will contain Ms.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

aware - The aware (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPartComplete

boolean isPartComplete()
                       throws IOException,
                              AutomationException

Indicates whether FinishPart has been called on the edit sketch.

Remarks

Use this property to determine when the current part of the sketch is finished.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The complete

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.