com.esri.arcgis.editor
Interface IEditSketch3

All Superinterfaces:

IEditSketch, IEditSketch2, Serializable

All Known Implementing Classes:

Editor, IEditSketch3Proxy

public interface IEditSketch3
extends IEditSketch2, Serializable

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

Remarks

IEditSketch3 extends the functionality available on IEditSketch2 to support alternative methods for adding geometries to the edit sketch, and provides mechanisms to ensure the edit sketch geometry has appropriate z-values. Use this interface when manipulating or capturing z-aware features when you want to control the method of z-value assignment.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	clearSelectedVertices() Clears selected vertices.
void	clearWYSIWYGSketchSymbol() Clears the WYSIWYG Sketch symbol and its properties.
int	getSelectedVertexCount() The number of selected vertices.
IShapeConstructor	getShapeConstructor() The currently activated Shape Constructor.
ISymbol	getWYSIWYGSketchSymbol() The WYSIWYG symbol for the sketch.
boolean	isSketchSymbolIsWYSIWYG() Indicates whether the sketch symbol is WYSIWYG.
boolean	isSketchSymbolRespectsRefScale() Indicates whether the sketch symbol should respect the map's reference scale.
boolean	isVertexSelected(int part, int vertex) Is a vertex selected.
void	selectVertex(int part, int vertex) Selects a vertex.
void	setShapeConstructorByRef(IShapeConstructor shapeConstructor) The currently activated Shape Constructor.
void	setWYSIWYGSketchSymbol(ISymbol symbol, boolean isWYSIWYG, boolean respectsRefScale) The WYSIWYG Sketch symbol and its properties.
void	unselectVertex(int part, int vertex) Unselects a vertex.

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

getCurrentZ, getEditSketchExtension, isMAware, isPartComplete, isZAware, setCurrentZ, setEditSketchExtensionByRef, setMAware, setZAware, vertexAdded, vertexDeleted, vertexMoved

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

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

Method Detail

isVertexSelected

boolean isVertexSelected(int part,
                         int vertex)
                         throws IOException,
                                AutomationException

Is a vertex selected.

Product Availability

Available with ArcGIS Desktop.

Parameters:

part - The part (in)

vertex - The vertex (in)

Returns:

The pbSelected

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearSelectedVertices

void clearSelectedVertices()
                           throws IOException,
                                  AutomationException

Clears selected vertices.

Product Availability

Available with ArcGIS Desktop.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

selectVertex

void selectVertex(int part,
                  int vertex)
                  throws IOException,
                         AutomationException

Selects a vertex.

Product Availability

Available with ArcGIS Desktop.

Parameters:

part - The part (in)

vertex - The vertex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

unselectVertex

void unselectVertex(int part,
                    int vertex)
                    throws IOException,
                           AutomationException

Unselects a vertex.

Product Availability

Available with ArcGIS Desktop.

Parameters:

part - The part (in)

vertex - The vertex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectedVertexCount

int getSelectedVertexCount()
                           throws IOException,
                                  AutomationException

The number of selected vertices.

Product Availability

Available with ArcGIS Desktop.

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWYSIWYGSketchSymbol

void setWYSIWYGSketchSymbol(ISymbol symbol,
                            boolean isWYSIWYG,
                            boolean respectsRefScale)
                            throws IOException,
                                   AutomationException

The WYSIWYG Sketch symbol and its properties.

Product Availability

Available with ArcGIS Desktop.

Parameters:

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

isWYSIWYG - The isWYSIWYG (in)

respectsRefScale - The respectsRefScale (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearWYSIWYGSketchSymbol

void clearWYSIWYGSketchSymbol()
                              throws IOException,
                                     AutomationException

Clears the WYSIWYG Sketch symbol and its properties.

Product Availability

Available with ArcGIS Desktop.

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWYSIWYGSketchSymbol

ISymbol getWYSIWYGSketchSymbol()
                               throws IOException,
                                      AutomationException

The WYSIWYG symbol for the sketch.

Product Availability

Available with ArcGIS Desktop.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSketchSymbolIsWYSIWYG

boolean isSketchSymbolIsWYSIWYG()
                                throws IOException,
                                       AutomationException

Indicates whether the sketch symbol is WYSIWYG.

Product Availability

Available with ArcGIS Desktop.

Returns:

The isWYSIWYG

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSketchSymbolRespectsRefScale

boolean isSketchSymbolRespectsRefScale()
                                       throws IOException,
                                              AutomationException

Indicates whether the sketch symbol should respect the map's reference scale.

Product Availability

Available with ArcGIS Desktop.

Returns:

The respectsRefScale

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShapeConstructor

IShapeConstructor getShapeConstructor()
                                      throws IOException,
                                             AutomationException

The currently activated Shape Constructor.

Product Availability

Available with ArcGIS Desktop.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShapeConstructorByRef

void setShapeConstructorByRef(IShapeConstructor shapeConstructor)
                              throws IOException,
                                     AutomationException

The currently activated Shape Constructor.

Product Availability

Available with ArcGIS Desktop.

Parameters:

shapeConstructor - A reference to a com.esri.arcgis.editor.IShapeConstructor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.