Editor framework customizations

In this topic

• Editor customizations and deployment options
• Commands
  • Context menus
• Tools
  • Creating an edit tool that uses shape constructors
  • Creating an edit tool that does not use shape constructors
  • Construction tools
• Tasks
  • When to create a task
  • Creating an edit task
  • Creating a tool to drive an edit task
• Extensions
• Shape constructors
  • Command component
  • Implementation component
• Object inspectors

Editor customizations and deployment options

Commands

private IEditor3 m_editor;
public override void OnCreate(object hook)
{
    m_application=hook as IApplication;
    //Get the editor.
    UID editorUid=new UID();
    editorUid.Value="esriEditor.Editor";
    m_editor=m_application.FindExtensionByCLSID(editorUid)as IEditor3;
}

public override void OnClick()
{
    //Developer code goes here.
}

public override bool Enabled
{
    get
    {
        return m_editor.EditState == esriEditState.esriStateEditing;
    }
}

Private m_application As IApplication
Public Overrides Sub OnCreate(ByVal hook As Object)
m_application=TryCast(hook, IApplication)
'Get the editor.
Dim editorUid As New UID()
editorUid.Value="esriEditor.Editor"
End Sub

Public Overrides Sub OnClick()
'Developer code goes here.
End Sub

Public Overrides ReadOnly Property Enabled() As Boolean
Get
Return m_editor.EditState=esriEditState.esriStateEditing
End Get
End Property

Context menus

• ESRI EditTool Menu Commands for commands on the Edit Tools context menu
• ESRI Sketch Menu Commands for commands on the Edit Sketch context menu
• ESRI SketchTool Menu Commands for commands on the Sketch Tool context menu

Tools

Creating an edit tool that uses shape constructors

1. Start with an ArcMap Class Library Visual Studio project.
2. Add a new item to the project and select Base tool from the ArcGIS Extending ArcObjects templates.
3. Select Desktop ArcMap Edit Tool in the ArcGIS New Item Wizard.
4. Change the BaseTool properties—such as name, caption, and so on.
5. Add any initialization code to the tool's OnCreate or OnClick method.
6. Add your code to the tool's OnSketchFinished event. This is the tool's functionality.
7. Compile and register the component.

Construction tools

Tasks

When to create a task

Creating an edit task

1. Create an empty library class (ArcMap) in Visual Studio using the templates under ArcGIS/Extending ArcObjects, and implement IEditTask from the editor library. The editor object is passed via the IEditTask.Activate method and can be used to access the sketch, IEditSketch. Most of your code should go in the IEditTask.OnFinishSketch method, which is called when the user completes the sketch.
2. Use the sketch geometry, IEditSketch.Geometry, to complete your task.
3. Compile and register the COM component. Edit tasks are registered under the ESRI Edit Tasks component category (EditTasks).

Creating a tool to drive an edit task

1. Set the editor's current task to the task you want to drive in the tool's OnClick event. You can find the registered task using the IEditTaskSearch interface or the IEditor.Task or IEditor.TaskCount loop.
2. Remove the tool's default OnSketchFinished event handler and code; the task will perform this work.

Extensions

Shape constructors

Command component

• The OnCreate method provides a hook into IApplication via the framework. A reference to the editor should be obtained within this method. See the following code example:

public override void OnCreate(object hook)
{
    if (hook == null)
        return ;
    m_application=hook as IApplication;

    //Get the editor.
    UID editorUid=new UID();
    editorUid.Value="esriEditor.Editor";
    m_editor=m_application.FindExtensionByCLSID(editorUid)as IEditor;
}

Public Overrides Sub OnCreate(ByVal hook As Object)
If hook Is Nothing Then
    Return
End If
m_application=TryCast(hook, IApplication)
'Get the editor.
Dim editorUid As New UID()
editorUid.Value="esriEditor.Editor"
m_editor=TryCast(m_application.FindExtensionByCLSID(editorUid), IEditor3)

public override void OnClick()
{
    // Create the constructor, pass the editor, and set as current constructor.
    m_edSketch=m_editor as IEditSketch3;
    AngleAngleCstr aac=new AngleAngleCstr();
    aac.Initialize(m_editor);
    m_edSketch.ShapeConstructor=aac;
}

Public Overrides Sub OnClick()
'Create the constructor, pass the editor, and set as current constructor.
m_edSketch=m_editor
Dim aac As AngleAngleCstr=New AngleAngleCstr()
aac.Initialize(m_editor)
m_edSketch.ShapeConstructor=aac
End Sub

public override bool Enabled
{
    // Enable the command if editing 
    // and current tool implements IShapeContructorTool.
    get
    {
        bool pEnabled=false;
        if (m_editor.EditState == esriEditState.esriStateEditing)
        {
            //Check for IShapeConstructorTool.
            IShapeConstructorTool psct=m_application.CurrentTool.Command as
                IShapeConstructorTool;
            pEnabled=(psct != null);
        }
        return (pEnabled);
    }

Public Overrides ReadOnly Property Enabled() As Boolean
Get
'Enable the command if editing
'and current tool implements IShapeContructorTool.
Dim pEnabled As Boolean=False
If (m_editor.EditState=esriEditState.esriStateEditing) Then
    'Check for IShapeConstructorTool.
    Dim csc As IShapeConstructorTool=m_application.CurrentTool.Command
    pEnabled=(csc IsNot Nothing)
    Return (pEnabled)
End If
End Get
End Property

public override bool Checked
{
    get
    {
        // Check the command/button if this is the current constructor.
        IPersist ptemp=m_edSketch.ShapeConstructor as IPersist;
        Guid pg;
        ptemp.GetClassID(out pg);
        return (pg.ToString() == "guid string");
    }
}

Public Overrides ReadOnly Property Checked() As Boolean
Get
'Check the command/button if this is the current constructor.
Dim ptemp As IPersist=m_edSketch.ShapeConstructor
Dim pg As Guid
ptemp.GetClassID(pg)
Return (pg.ToString()="guid string")
End Get
End Property

Implementation component

class AngleAngleCstr: IShapeConstructor, IPersist public override void Initialize
    (IEditor pEditor)
{
    m_editor=pEditor;
    m_EdSketch=m_editor as IEditSketch3;
}

Public Class AngleAngleCstr
    Implements IShapeConstructor, IPersist

    Public Sub Initialize(ByVal pEditor As IEditor) Implements IShapeConstructor.Initialize
        'Initialize the shape constructor.
        m_editor=pEditor
        m_edSketch=pEditor
    End Sub

public void GetClassID(out Guid pClassID)
{
    //Explicitly set a guid.
    //Used to set command.checked property.
    pClassID=new Guid("guid string");
}

Public Sub GetClassID(ByRef pClassID As System.Guid) Implements IPersist.GetClassID
    'Explicitly set a guid. Used to set command.checked property.
    pClassID=New Guid("guid string")
End Sub

Object inspectors

See Also:

• ESRI.ArcGIS.Editor