How to pass the ArcGIS Desktop application from a command or tool

In this topic

• Extending ArcGIS Desktop with custom commands or tools
  • Creating an application-specific command
  • Creating a generic command
  • Passing the hook object to dialog boxes or other .NET components

Extending ArcGIS Desktop with custom commands or tools

Creating an application-specific command  

1. Create an ArcGIS Desktop class library project targeting the application of your choice, for example, ArcMap. For more information, see Choosing an ArcGIS Desktop project template.
2. Create a command using the ArcGIS Base Command templates. Select the ArcGIS Desktop application option where you want to create the command, for example, Desktop ArcMap command. For more information, see the previously referenced topic, Creating commands and tools.
3. Specify command properties in the constructor, for example, set the category to .NET Samples caption to My Command, and the name to NETSamples_MyCommand.
4. Examine how the code in the OnCreate method handles the incoming hook parameter, for example, IMxApplication for ArcMap.
5. Go to the OnClick method and add code to display the name of the application in which the command resides. See the following code example:

IMessageDialog msgDialog=new MessageDialogClass();
msgDialog.DoModal("Test", "My command works in " + m_app.Name, "", "", 0);

Dim msgDialog As IMessageDialog=New MessageDialogClass()
msgDialog.DoModal("Test", "My command works in " + m_app.Name, "", "", 0)

Creating a generic command

1. Omit the check for a specific application in the OnCreate method by commenting out or deleting lines of code in the following code example:

//Disable if it is not ArcMap.
//if (hook is IMxApplication)
//base.m_enabled=true;
//else
//base.m_enabled=false;

'Disable if it is not ArcMap.
'If TypeOf hook Is IMxApplication Then
'MyBase.m_enabled=True
'Else
'MyBase.m_enabled=False
'End If

2. Add code to register your class into all desktop application command categories using the ArcGIS Component Category Registrar dialog box. Select the following categories on the dialog box:
   • ArcMap Commands
   • ArcCatalog Commands
   • ArcGlobe Commands
   • ArcScene Commands
3. Run or debug your command in any of the desktop applications. When debugging, switch the debug application project property to the appropriate application path.
4. Drag and drop the command from the Customize dialog box, and click the command to display a message with the application name.

Passing the hook object to dialog boxes or other .NET components

1. Create a desktop command using the ArcGIS Base Command template. Follow Steps 1–3 in Creating an application-specific command.
2. Add a form to your project, for example, Form1.
3. Add a button to your form.
4. Add a write-only property to the form to accept the application object.
   
   See the following code example:

public partial class Form1: Form
{
    private IApplication m_application;
    ... public IApplication ArcGISApplication
    {
        set
        {
            m_application=value;
        }
    }
    ...
}

Public Class Form1
    Private m_application As IApplication
    Public WriteOnly Property ArcGISApplication() As IApplication
    Set(ByVal Value As IApplication)
    m_application=Value
    End Set
End Property

...
End Class

private void button1_Click(object sender, EventArgs e)
{
    MessageBox.Show(m_application.Name);
}

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
    MsgBox(m_application.Name)
End Sub

public sealed class Command1: BaseCommand
{
    private Form1 m_form;
    ... public override void OnClick()
    {
        //Initialize form.
        if (m_form == null || m_form.IsDisposed)
        {
            m_form=new Form1();
            m_form.ArcGISApplication=m_application;
        }
        //Show form (modeless).
        if (!m_form.Visible)
            m_form.Show();
    }
    ...
}

Public NotInheritable Class Command1
Inherits BaseCommand
...
Public Overrides Sub OnClick()
'Initialize form.
If m_form Is Nothing OrElse m_form.IsDisposed Then
    m_form=New Form1()
    m_form.ArcGISApplication=m_application
End If
'Show form (modeless).
If Not m_form.Visible Then m_form.Show()
End Sub

...
End Class

See Also:

• ESRI.ArcGIS.Framework