com.esri.arcgis.editor
Interface IEditor3

All Superinterfaces:

IEditor, IEditor2, Serializable

All Known Implementing Classes:

Editor, IEditor3Proxy

public interface IEditor3
extends IEditor2, Serializable

Provides access to methods that extend the IEditor interface. The additional members control the behavior of the template construction and snapping.

Product Availability

Available with ArcGIS Desktop.

Method Summary

void	addTemplates(IArray editTemplateArray) Adds the specified edit template.
IEditTemplate	getCurrentTemplate() The current edit template.
IEditTemplate	getTemplate(int index) The edit template for the specified index.
int	getTemplateCount() The number of edit templates.
void	removeAllTemplatesInLayer(ILayer layer) Removes all templates from the specified layer.
void	removeAllTemplatesInMap(IMap map) Removes all templates from the specified map.
void	removeTemplate(IEditTemplate editTemplate) Removes the specified edit template.
void	setCurrentTemplateByRef(IEditTemplate editTemplate) The current edit template.
void	templateModified(IEditTemplate editTemplate) Broadcasts the change to the rest of the system.

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

getAuxiliarySelectionAnchor, isAuxiliarySelectionAnchorEnabled, resetAuxiliarySelectionAnchorLocation, setAuxiliarySelectionAnchorEnabled

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

abortOperation, createSearchShape, delayEvents, enableUndoRedo, findExtension, getCurrentTask, getDisplay, getEditSelection, getEditState, getEditWorkspace, getLocation, getMap, getParent, getScratchWorkspace, getSelectionAnchor, getSelectionCount, getTask, getTaskCount, hasEdits, invertAgent, redoOperation, searchSelection, setCurrentTaskByRef, startEditing, startOperation, stopEditing, stopOperation, undoOperation

Method Detail

getTemplateCount

int getTemplateCount()
                     throws IOException,
                            AutomationException

The number of edit templates.

Remarks

This method returns the total number of templates for all layers within the current edit workspace. The returned value will be 0 if you are not in an edit session. To examine templates for layers outside an edit session refer to IEditTemplateManager in the Carto assembly.

Product Availability

Available with ArcGIS Desktop.

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemplate

IEditTemplate getTemplate(int index)
                          throws IOException,
                                 AutomationException

The edit template for the specified index.

Product Availability

Available with ArcGIS Desktop.

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addTemplates

void addTemplates(IArray editTemplateArray)
                  throws IOException,
                         AutomationException

Adds the specified edit template. The template was created with the EditTemplateFactory.

Product Availability

Available with ArcGIS Desktop.

Parameters:

editTemplateArray - A reference to a com.esri.arcgis.system.IArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeTemplate

void removeTemplate(IEditTemplate editTemplate)
                    throws IOException,
                           AutomationException

Removes the specified edit template.

Product Availability

Available with ArcGIS Desktop.

Parameters:

editTemplate - A reference to a com.esri.arcgis.carto.IEditTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllTemplatesInLayer

void removeAllTemplatesInLayer(ILayer layer)
                               throws IOException,
                                      AutomationException

Removes all templates from the specified layer.

Product Availability

Available with ArcGIS Desktop.

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAllTemplatesInMap

void removeAllTemplatesInMap(IMap map)
                             throws IOException,
                                    AutomationException

Removes all templates from the specified map.

Product Availability

Available with ArcGIS Desktop.

Parameters:

map - A reference to a com.esri.arcgis.carto.IMap (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentTemplate

IEditTemplate getCurrentTemplate()
                                 throws IOException,
                                        AutomationException

The current edit template.

Product Availability

Available with ArcGIS Desktop.

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCurrentTemplateByRef

void setCurrentTemplateByRef(IEditTemplate editTemplate)
                             throws IOException,
                                    AutomationException

The current edit template.

Product Availability

Available with ArcGIS Desktop.

Parameters:

editTemplate - A reference to a com.esri.arcgis.carto.IEditTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

templateModified

void templateModified(IEditTemplate editTemplate)
                      throws IOException,
                             AutomationException

Broadcasts the change to the rest of the system.

Product Availability

Available with ArcGIS Desktop.

Parameters:

editTemplate - A reference to a com.esri.arcgis.carto.IEditTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.