Provides access to members that control the behavior of the editor. Note: the IEditor interface has been superseded byIEditor3. Please consider using the more recent version.
Product Availability
Available with ArcGIS Desktop.
When To Use
The IEditor interface is the main interface used to
control the actions of the editor. For example, use the members in
this interface to start and stop an edit session, create and manage
edit operations, and set the editor's current task.
Members
Description | ||
---|---|---|
AbortOperation | Aborts an edit operation. | |
CreateSearchShape | Creates a geometry using the point and the current search tolerance. | |
CurrentTask | The current edit task. | |
DelayEvents | Used to batch operations together and minimize notifications. | |
Display | Reference to the current display. | |
EditSelection | The selected features which are editable. | |
EditState | The editor's current edit state. | |
EditWorkspace | Reference to the workspace being edited. | |
EnableUndoRedo | Enable/disable the undo/redo capabilities. | |
FindExtension | Finds the extension given an id. | |
HasEdits | Indicates whether edits have been made during the session. | |
InvertAgent | Draws the editor's snapping agent. | |
Location | The last known location of the mouse. | |
Map | Reference to the map being edited. | |
Parent | Reference to the parent application. | |
RedoOperation | Redo an edit operation. | |
ScratchWorkspace | Reference to the editor's scratch workspace. | |
SearchSelection | Searches the edit selection using the given location. | |
SelectionAnchor | The selection anchor point. | |
SelectionCount | The number of selected features which are editable. | |
StartEditing | Starts an edit session. | |
StartOperation | Starts an edit operation. | |
StopEditing | Stops an edit session. | |
StopOperation | Stops an edit operation. | |
Task | An edit task by index. | |
TaskCount | The number of edit tasks. | |
UndoOperation | Undo an edit operation. |
CoClasses that implement IEditor
CoClasses and Classes | Description |
---|---|
Editor | The Object Editor Extension. |
[C#]
private IEditor m_editor;
private IApplication m_application;
// Would get the app by using hook during implementation of CreateCommand
...
UID uID = new UID();
uID.Value = "esriEditor.Editor";
if (app == null)
return;
m_editor = app.FindExtensionByCLSID(uID) as IEditor;
//To use the Editor name instead of UID
....
if (app == null)
return;
m_editor = app.FindExtensionByName("ESRI Object Editor") as IEditor;
[Visual Basic .NET]
In VB.Net you would get the reference to IApplication from hook in the ICommand::OnCreate() hook parameter
Private m_editor As IEditor
Private m_application As IApplication
...
Public Overrides Sub OnCreate(ByVal hook As Object)
If Not (hook Is Nothing) Then
If TypeOf (hook) Is IApplication Then
m_application = CType(hook, IApplication)
End If
Else
Exit Sub
End If
Dim uID As New UID
m_application = hook
uID.Value = "esriEditor.Editor"
m_editor = m_application.FindExtensionByCLSID(uID)
End Sub
Or it can be found by name.
...
...
m_editor = m_application.FindExtensionByName("ESRI Object Editor")
End Sub
See Also
IDatasetEdit Interface | IDatasetEditInfo Interface | Editor Class | IEditTask.OnFinishSketch Method | IEditor Interface | IEditTask.OnDeleteSketch Method | IEditTask.Activate Method | IEditTask.Deactivate Method | IEditSketch Interface | IEditAttributeProperties Interface | IEditLayers Interface | IEditEvents Interface | IEditTask.Name Property | IEditProperties Interface | IEditEvents2 Interface | ISnapEnvironment Interface | IApplication Interface | IMap Interface