Run C# form when ArcMap mxd is opened

Question

I have created a form in C# which collects data such as name, date, workspace and several other fields from the user and stores this data in a temporary .txt file to be used later by other functions.

I am trying figure out how to make an ArcMap MXD that when opened will automatically open and run this form and solicit this data from the user.

Answer 1

You should write an ArcMap Addin Extension. In the extension, listen to DocumentOpened event and from there, show your form. Useful Link

To create the extension, use Arcgis visual studio template.

Then change SetupEvents method like this:

private void SetupEvents()
        {
            m_docEvents = ArcMap.Document as IDocumentEvents_Event; 
            m_docEvents.OpenDocument += new IDocumentEvents_OpenDocumentEventHandler(OnOpenDocument);
        }

private void OnOpenDocument()
        {
//Show your form here
}

Answer 2

That works Farid Cher, but another helpful tip is to use the autoLoad property in the Config.esriaddinx:

 <Extensions>
    <Extension id="Microsoft_OnSave_Extension1" class="Extension1" productName="OnSaveExt" showInExtensionDialog="true" autoLoad="true" />
  </Extensions>

This may not be there by default but it is safe to add, it forces the tool to execute as ArcMap is initialized (before you even see it). Then in the code use the OnStartup to wire the OpenDocument event of ArcMap events:

//this goes in OnStartup
IDocumentEvents_Event eDocEvents = (IDocumentEvents_Event)ArcMap.Document;
eDocEvents.OpenDocument += new IDocumentEvents_OpenDocumentEventHandler(eDocEvents_OpenDocument);

void eDocEvents_OpenDocument()
{
    // do your procedure in here
}

This is the C# translation of working VB code taken from an answer How to trigger a Python script from an ArcGIS Desktop "save" operation? that I have done previously.. I'm hoping nothing has got lost in the translation: the original was VB to be executed in python now translated to C#.

As you can see it's the same (essentially) as the answer by Farid Cher (+1 for that) except that it's not using an extension method, simply an ArcMap Addin, which doesn't need to be installed and can be handled the same as any Esri Addin.