nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

ArcGIS Pro 2.4 add in that would execute after a project is loaded

FrankMartin1

I have an ArcGIS Pro 2.4 add in that I would like to have execute after a project is loaded, but does not require the user to click a button or select a tool. Essentially, it would act like a onload function. Is there any way to accomplish this with an add in?

Thanks for your help,

Frank

Find more posts tagged with

Accepted answers

FrankMartin1

Thanks to everyone for their suggestions. I used Than's suggestion to subscribe to the ActiveMapViewChangedEvent in the module (se below), and it works. Now, when a project loads the add in code is executed immediately without having to activate it through a button. I used Uma's suggestions to "hide" the button by setting the the loadOnClick attribute to false in the button definition.

Again, thanks to everyone for their help!

Regards,

Frank

        <SPAN class="keyword token">protected</SPAN> <SPAN class="keyword token">override</SPAN> <SPAN class="keyword token">bool</SPAN> <SPAN class="token function">Initialize</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
        <SPAN class="punctuation token">{</SPAN>
            ArcGIS<SPAN class="punctuation token">.</SPAN>Desktop<SPAN class="punctuation token">.</SPAN>Mapping<SPAN class="punctuation token">.</SPAN>Events<SPAN class="punctuation token">.</SPAN>ActiveMapViewChangedEvent<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Subscribe</SPAN><SPAN class="punctuation token">(</SPAN>MapViewActivateEvent<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
            <SPAN class="keyword token">return</SPAN> <SPAN class="keyword token">true</SPAN><SPAN class="punctuation token">;</SPAN>
        <SPAN class="punctuation token">}</SPAN>

        <SPAN class="keyword token">private</SPAN> <SPAN class="keyword token">void</SPAN> <SPAN class="token function">MapViewActivateEvent</SPAN><SPAN class="punctuation token">(</SPAN>ActiveMapViewChangedEventArgs obj<SPAN class="punctuation token">)</SPAN>
        <SPAN class="punctuation token">{</SPAN>
            <SPAN class="keyword token">try</SPAN>
            <SPAN class="punctuation token">{</SPAN>

               <SPAN class="keyword token">var</SPAN> layerEventListeners <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">List</SPAN><SPAN class="operator token"><</SPAN><SPAN class="keyword token">string</SPAN><SPAN class="operator token">></SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

               <SPAN class="keyword token">var</SPAN> featureLayers <SPAN class="operator token">=</SPAN> mapView<SPAN class="punctuation token">.</SPAN>Map<SPAN class="punctuation token">.</SPAN>Layers<SPAN class="punctuation token">.</SPAN>OfType<SPAN class="operator token"><</SPAN>FeatureLayer<SPAN class="operator token">></SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

<SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN>
            <SPAN class="punctuation token">}</SPAN>
<SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN>
         <SPAN class="punctuation token">}</SPAN>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

All comments

UmaHarano

Hi Frank,

In your add-in's config.daml, set the "autoLoad" attribute to true and the button element's loadOnClick attribute to false to accomplish this.

..
<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>modules</SPAN><SPAN class="punctuation token">></SPAN></SPAN>
<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>insertModule</SPAN> <SPAN class="attr-name token">id</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>QueryBuilderControl_Module<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">className</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>Module1<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">autoLoad</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>true<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">caption</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>Module1<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN>
....‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

 <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>controls</SPAN><SPAN class="punctuation token">></SPAN></SPAN>
  <SPAN class="comment token"><!-- add your controls here --></SPAN>
  <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>button</SPAN> <SPAN class="attr-name token">id</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>QueryBuilderControl_DefinitionQueryDockPane_ShowButton<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">loadOnClick</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>false<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">caption</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>Show DefinitionQueryDockPane<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">...</SPAN><SPAN class="punctuation token">></SPAN></SPAN>
          <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>tooltip</SPAN> <SPAN class="attr-name token">heading</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>Show Dockpane<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN>Show Dockpane<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>disabledText</SPAN> <SPAN class="punctuation token">/></SPAN></SPAN><SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN>tooltip</SPAN><SPAN class="punctuation token">></SPAN></SPAN>
        <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN>button</SPAN><SPAN class="punctuation token">></SPAN></SPAN>
 <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN>controls</SPAN><SPAN class="punctuation token">></SPAN></SPAN>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Thanks

Uma

FrankMartin1

Uma,

Thanks. I've changed both the autoLoad and loadOnClick as you suggested, however, the button code does not execute until the button has been click.

<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>modules</SPAN><SPAN class="punctuation token">></SPAN></SPAN>
 <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>insertModule</SPAN> <SPAN class="attr-name token">id</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>EditRBIDGeneratorPro_Module<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">className</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>Module1<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">autoLoad</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>true<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">caption</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>Module1<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>button</SPAN> <SPAN class="attr-name token">id</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>EditRBIDGeneratorPro_Button1<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">caption</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>RBID Activate<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">className</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>Button1<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">loadOnClick</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>false<SPAN class="punctuation token">"</SPAN></SPAN> <SPAN class="attr-name token">...</SPAN><SPAN class="punctuation token">></SPAN></SPAN>
 <SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>tooltip</SPAN> <SPAN class="attr-name token">heading</SPAN><SPAN class="attr-value token"><SPAN class="punctuation token">=</SPAN><SPAN class="punctuation token">"</SPAN>RBID Activate Tooltip<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN>Click to ensure the automatic addition of a RBID during edit sessions<SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"><</SPAN>disabledText</SPAN> <SPAN class="punctuation token">/></SPAN></SPAN><SPAN class="token tag"><SPAN class="token tag"><SPAN class="punctuation token"></</SPAN>tooltip</SPAN><SPAN class="punctuation token">></SPAN></SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

The code I'm trying to execute is within the the OnClick function. Is that the issue?

<SPAN class="keyword token">namespace</SPAN> EditRBIDGeneratorPro
<SPAN class="punctuation token">{</SPAN>
 <SPAN class="keyword token">internal</SPAN> <SPAN class="keyword token">class</SPAN> <SPAN class="token class-name">Button1</SPAN> <SPAN class="punctuation token">:</SPAN> Button
 <SPAN class="punctuation token">{</SPAN>
   <SPAN class="keyword token">private</SPAN> Incrementor uid<SPAN class="punctuation token">;</SPAN>
   <SPAN class="keyword token">protected</SPAN> <SPAN class="keyword token">override</SPAN> <SPAN class="keyword token">async</SPAN> <SPAN class="keyword token">void</SPAN> <SPAN class="token function">OnClick</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
   <SPAN class="punctuation token">{</SPAN>
     <SPAN class="keyword token">try</SPAN>
     <SPAN class="punctuation token">{</SPAN>
         <SPAN class="keyword token">var</SPAN> mapView <SPAN class="operator token">=</SPAN> MapView<SPAN class="punctuation token">.</SPAN>Active<SPAN class="punctuation token">;</SPAN>
         <SPAN class="keyword token">if</SPAN> <SPAN class="punctuation token">(</SPAN>mapView <SPAN class="operator token">==</SPAN> <SPAN class="keyword token">null</SPAN><SPAN class="punctuation token">)</SPAN>
         <SPAN class="punctuation token">{</SPAN>
             <SPAN class="keyword token">var</SPAN> startString <SPAN class="operator token">=</SPAN> <SPAN class="string token">"No map view"</SPAN><SPAN class="punctuation token">;</SPAN>
             MessageBox<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Show</SPAN><SPAN class="punctuation token">(</SPAN>startString<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
         <SPAN class="punctuation token">}</SPAN>
         <SPAN class="keyword token">var</SPAN> featureLayers <SPAN class="operator token">=</SPAN> mapView<SPAN class="punctuation token">.</SPAN>Map<SPAN class="punctuation token">.</SPAN>Layers<SPAN class="punctuation token">.</SPAN>OfType<SPAN class="operator token"><</SPAN>FeatureLayer<SPAN class="operator token">></SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

<SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN>

     <SPAN class="punctuation token">}</SPAN>
     <SPAN class="keyword token">catch</SPAN> <SPAN class="punctuation token">(</SPAN><SPAN class="token class-name">Exception</SPAN> ex<SPAN class="punctuation token">)</SPAN>
     <SPAN class="punctuation token">{</SPAN>
         <SPAN class="keyword token">var</SPAN> ErrorString <SPAN class="operator token">=</SPAN> ex<SPAN class="punctuation token">.</SPAN>Message<SPAN class="punctuation token">;</SPAN>
         MessageBox<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Show</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"An error occurred while updating attribute column data "</SPAN> <SPAN class="operator token">+</SPAN> ErrorString<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
  <SPAN class="punctuation token">}</SPAN> 
<SPAN class="punctuation token">}</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Thanks again,

Frank

ChristopherMoore

You'll probably want to subscribe to the project opened event in your EditRBIDGeneratorPro_Module.Initialize method, for example:

internal class EditRBIDGeneratorPro_Module : Module

{

protected override bool Initialize()

{

    ArcGIS.Desktop.Core.Events.ProjectOpenedEvent.Subscribe(async (args) => {
       // Call Desired Method
    });

}

Anonymous User

Hi Frank,

Based on your button click event code, it seems you are trying to perform something when the mapview is active.

If so,

Use this,

In module class, add these

protected override bool Initialize()
{
ArcGIS.Desktop.Mapping.Events.ActiveMapViewChangedEvent.Subscribe(this.MapViewActivateEvent);

return true;
}

private void MapViewActivateEvent(ActiveMapViewChangedEventArgs obj)
{
try
{
var mapView = MapView.Active;
if (mapView == null)
{
var startString = "No map view";
ProDialog.MessageBox.Show(startString);
}
var featureLayers = mapView.Map.Layers.OfType<FeatureLayer>();

}
catch (Exception ex)
{
var ErrorString = ex.Message;
ProDialog.MessageBox.Show("An error occurred while updating attribute column data " + ErrorString);
}
}

UmaHarano

Hi Frank,

The loadOnClick attribute only determines when the button should be created by the framework.

Thanks

Uma

FrankMartin1

Again, thanks to everyone for their help!

Regards,

Frank

        <SPAN class="keyword token">protected</SPAN> <SPAN class="keyword token">override</SPAN> <SPAN class="keyword token">bool</SPAN> <SPAN class="token function">Initialize</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
        <SPAN class="punctuation token">{</SPAN>
            ArcGIS<SPAN class="punctuation token">.</SPAN>Desktop<SPAN class="punctuation token">.</SPAN>Mapping<SPAN class="punctuation token">.</SPAN>Events<SPAN class="punctuation token">.</SPAN>ActiveMapViewChangedEvent<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Subscribe</SPAN><SPAN class="punctuation token">(</SPAN>MapViewActivateEvent<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
            <SPAN class="keyword token">return</SPAN> <SPAN class="keyword token">true</SPAN><SPAN class="punctuation token">;</SPAN>
        <SPAN class="punctuation token">}</SPAN>

        <SPAN class="keyword token">private</SPAN> <SPAN class="keyword token">void</SPAN> <SPAN class="token function">MapViewActivateEvent</SPAN><SPAN class="punctuation token">(</SPAN>ActiveMapViewChangedEventArgs obj<SPAN class="punctuation token">)</SPAN>
        <SPAN class="punctuation token">{</SPAN>
            <SPAN class="keyword token">try</SPAN>
            <SPAN class="punctuation token">{</SPAN>

               <SPAN class="keyword token">var</SPAN> layerEventListeners <SPAN class="operator token">=</SPAN> <SPAN class="keyword token">new</SPAN> <SPAN class="token class-name">List</SPAN><SPAN class="operator token"><</SPAN><SPAN class="keyword token">string</SPAN><SPAN class="operator token">></SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

               <SPAN class="keyword token">var</SPAN> featureLayers <SPAN class="operator token">=</SPAN> mapView<SPAN class="punctuation token">.</SPAN>Map<SPAN class="punctuation token">.</SPAN>Layers<SPAN class="punctuation token">.</SPAN>OfType<SPAN class="operator token"><</SPAN>FeatureLayer<SPAN class="operator token">></SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

<SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN>
            <SPAN class="punctuation token">}</SPAN>
<SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="punctuation token">.</SPAN>
         <SPAN class="punctuation token">}</SPAN>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍<SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

Join the Conversation

Signed in members can post, follow updates, and more. New here? Register a free account.

Quick Links

Community Help
Find useful guides, FAQs, and documents to help you navigate and make the most of Esri Community.