com.esri.arcgis.editor
Interface IEditProperties4

All Superinterfaces:
Serializable
All Known Implementing Classes:
Editor, IEditProperties4Proxy

public interface IEditProperties4
extends Serializable

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

When To Use

The IEditProperties4 interface is used to control the z editing capabilities of the editor. Properties include: ZCaptureType, UseZFactor, ZFactor, UseZOffset, ZOffset, UseZDrapingTolerance, ZDrapingTolerance, Draping, Surface and ZSnapSymbol.

Product Availability

Available with ArcGIS Desktop.


Method Summary
 IMarkerSymbol getActiveSelectedVertexSymbol()
          Symbol used to draw the selected active vertex of the edit sketch.
 IMarkerSymbol getActiveSketchVertexSymbol()
          Symbol used to draw the selected vertices of the edit sketch.
 boolean isClassicSnapping()
          Indicates whether the classic editing snapping will be used.
 boolean isShowConstructionToolbars()
          Indicates whether construction toolbars will be displayed while drawing a sketch.
 boolean isSnapToSketch()
          Indicates whether the sketch will be added to the snapping cache.
 boolean isUseWYSIWYGSketchSymbol()
          Indicates whether the sketch is drawn with WYSIWYG symbology.
 void setActiveSelectedVertexSymbolByRef(IMarkerSymbol symbol)
          Symbol used to draw the selected active vertex of the edit sketch.
 void setActiveSketchVertexSymbolByRef(IMarkerSymbol symbol)
          Symbol used to draw the selected vertices of the edit sketch.
 void setClassicSnapping(boolean snap)
          Indicates whether the classic editing snapping will be used.
 void setShowConstructionToolbars(boolean showConstructionToolbars)
          Indicates whether construction toolbars will be displayed while drawing a sketch.
 void setSnapToSketch(boolean snap)
          Indicates whether the sketch will be added to the snapping cache.
 void setUseWYSIWYGSketchSymbol(boolean useWYSIWYGSketchSymbol)
          Indicates whether the sketch is drawn with WYSIWYG symbology.
 

Method Detail

isUseWYSIWYGSketchSymbol

boolean isUseWYSIWYGSketchSymbol()
                                 throws IOException,
                                        AutomationException
Indicates whether the sketch is drawn with WYSIWYG symbology.

Remarks

This property determines whether or not the feature being edited or created is drawn using the rendererís symbol, or the classic edit sketch symbology.

Product Availability

Available with ArcGIS Desktop.

Returns:
The useWYSIWYGSketchSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseWYSIWYGSketchSymbol

void setUseWYSIWYGSketchSymbol(boolean useWYSIWYGSketchSymbol)
                               throws IOException,
                                      AutomationException
Indicates whether the sketch is drawn with WYSIWYG symbology.

Product Availability

Available with ArcGIS Desktop.

Parameters:
useWYSIWYGSketchSymbol - The useWYSIWYGSketchSymbol (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isClassicSnapping

boolean isClassicSnapping()
                          throws IOException,
                                 AutomationException
Indicates whether the classic editing snapping will be used.

Remarks

Setting this property to true enables classic snapping (ArcGIS 9.3.1 and prior versions snapping environment UI).

In the UI this is set in the general tab on the Editor Options dialog.

Product Availability

Available with ArcGIS Desktop.

Returns:
The snap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setClassicSnapping

void setClassicSnapping(boolean snap)
                        throws IOException,
                               AutomationException
Indicates whether the classic editing snapping will be used.

Product Availability

Available with ArcGIS Desktop.

Parameters:
snap - The snap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSnapToSketch

boolean isSnapToSketch()
                       throws IOException,
                              AutomationException
Indicates whether the sketch will be added to the snapping cache. It is used when not using classic snapping.

Remarks

Setting this property to true adds the sketch to the snapping cache.

In the UI this property is set via the Snap to Sketch menu item on the Snapping toolbar.

Product Availability

Available with ArcGIS Desktop.

Returns:
The snap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSnapToSketch

void setSnapToSketch(boolean snap)
                     throws IOException,
                            AutomationException
Indicates whether the sketch will be added to the snapping cache. It is used when not using classic snapping.

Product Availability

Available with ArcGIS Desktop.

Parameters:
snap - The snap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isShowConstructionToolbars

boolean isShowConstructionToolbars()
                                   throws IOException,
                                          AutomationException
Indicates whether construction toolbars will be displayed while drawing a sketch.

Remarks

Setting this property to true will display the construction mini toolbar during sketch construction.

In the UI this is set in the General tab on the Editor Options dialog.

Product Availability

Available with ArcGIS Desktop.

Returns:
The showConstructionToolbars
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShowConstructionToolbars

void setShowConstructionToolbars(boolean showConstructionToolbars)
                                 throws IOException,
                                        AutomationException
Indicates whether construction toolbars will be displayed while drawing a sketch.

Product Availability

Available with ArcGIS Desktop.

Parameters:
showConstructionToolbars - The showConstructionToolbars (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getActiveSketchVertexSymbol

IMarkerSymbol getActiveSketchVertexSymbol()
                                          throws IOException,
                                                 AutomationException
Symbol used to draw the selected vertices of the edit sketch.

Remarks

Use this property to change the symbology of the selected vertices in the edit sketch. By default, selected edit sketch vertices are drawn as hollow green squares.

In the UI this is set in the general tab on the Editor Options dialog.

Product Availability

Available with ArcGIS Desktop.

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.
See Also:
IEditProperties.getSketchVertexSymbol(), IEditProperties.getSketchSymbol()

setActiveSketchVertexSymbolByRef

void setActiveSketchVertexSymbolByRef(IMarkerSymbol symbol)
                                      throws IOException,
                                             AutomationException
Symbol used to draw the selected vertices of the edit sketch.

Product Availability

Available with ArcGIS Desktop.

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.

getActiveSelectedVertexSymbol

IMarkerSymbol getActiveSelectedVertexSymbol()
                                            throws IOException,
                                                   AutomationException
Symbol used to draw the selected active vertex of the edit sketch.

Remarks

Use this property to change the symbology of the last point in the edit sketch when it is selected. By default this point is drawn as a red hollow square.

In the UI this is set in the general tab on the Editor Options dialog.

Product Availability

Available with ArcGIS Desktop.

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.
See Also:
IEditProperties.getSketchVertexSymbol(), IEditProperties.getSketchSymbol()

setActiveSelectedVertexSymbolByRef

void setActiveSelectedVertexSymbolByRef(IMarkerSymbol symbol)
                                        throws IOException,
                                               AutomationException
Symbol used to draw the selected active vertex of the edit sketch.

Product Availability

Available with ArcGIS Desktop.

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.