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; } } }

Loadonclick button - ribbon bar

Anonymous User

Hi Guys,

I want to load/initialize the ribbon bar button after the module is intialized.

So I set loadOnClick="false" property on button control in daml.

And I add a few code at constructor.

However the constructor only call when the tab is activated.

So how shall I force the button to load upon project is loaded.

If the tab which hold the button need to be activated, how shall I achieve it? Uma Harano‌ Wolfgang Kaiser‌

I am using pro 2.5.

Trouver plus de publications taguées avec

Accepted answers

Wolf

You can get the IPluginWrapper interface by using the button's ID from the config.daml. Below is the snippet that i added to my test add-in's Module class:

<SPAN class="keyword token">protected</SPAN> <SPAN class="keyword token">override</SPAN> <SPAN class="keyword token">bool</SPAN> Initialize <SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
<SPAN class="punctuation token">{</SPAN>
  ActiveMapViewChangedEvent<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Subscribe</SPAN><SPAN class="punctuation token">(</SPAN>OnActiveMapViewChanged<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

  <SPAN class="keyword token">return</SPAN> <SPAN class="keyword token">base</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="token function">Initialize</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
<SPAN class="punctuation token">}</SPAN>

<SPAN class="comment token">/// <summary></SPAN>
<SPAN class="comment token">/// Event delegate for the ActiveMapViewChangedEvent</SPAN>
<SPAN class="comment token">/// </summary></SPAN>
<SPAN class="keyword token">private</SPAN> <SPAN class="keyword token">void</SPAN> <SPAN class="token function">OnActiveMapViewChanged</SPAN><SPAN class="punctuation token">(</SPAN>ActiveMapViewChangedEventArgs args<SPAN class="punctuation token">)</SPAN>
<SPAN class="punctuation token">{</SPAN>
  <SPAN class="comment token">// get the button and change the caption</SPAN>
  <SPAN class="comment token">// button's id from config.daml: DynamicButtonChange_ButtonMapLoaded</SPAN>
  <SPAN class="keyword token">var</SPAN> plugin <SPAN class="operator token">=</SPAN> FrameworkApplication<SPAN class="punctuation token">.</SPAN><SPAN class="token function">GetPlugInWrapper</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"DynamicButtonChange_ButtonMapLoaded"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
  <SPAN class="keyword token">if</SPAN> <SPAN class="punctuation token">(</SPAN>args<SPAN class="punctuation token">.</SPAN>IncomingView <SPAN class="operator token">==</SPAN> <SPAN class="keyword token">null</SPAN><SPAN class="punctuation token">)</SPAN>
  <SPAN class="punctuation token">{</SPAN>
    plugin<SPAN class="punctuation token">.</SPAN>Caption <SPAN class="operator token">=</SPAN> <SPAN class="string token">"No Mapview"</SPAN><SPAN class="punctuation token">;</SPAN>
    <SPAN class="comment token">// plugin.LargeImage = ...</SPAN>
    <SPAN class="keyword token">return</SPAN><SPAN class="punctuation token">;</SPAN>
  <SPAN class="punctuation token">}</SPAN>
  plugin<SPAN class="punctuation token">.</SPAN>Caption <SPAN class="operator token">=</SPAN> <SPAN class="string token">"Active Mapview"</SPAN><SPAN class="punctuation token">;</SPAN>
  <SPAN class="comment token">// plugin.LargeImage = ...</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>

All comments

Anonymous User

That's great Wolfgang Kaiser‌,

That help me centralize the state management in module class.

And one interesting part is that that trigger the button class instantiation as well. Not require to click tab.

Wolf

You can get the IPluginWrapper interface by using the button's ID from the config.daml. Below is the snippet that i added to my test add-in's Module class:

<SPAN class="keyword token">protected</SPAN> <SPAN class="keyword token">override</SPAN> <SPAN class="keyword token">bool</SPAN> Initialize <SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
<SPAN class="punctuation token">{</SPAN>
  ActiveMapViewChangedEvent<SPAN class="punctuation token">.</SPAN><SPAN class="token function">Subscribe</SPAN><SPAN class="punctuation token">(</SPAN>OnActiveMapViewChanged<SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>

  <SPAN class="keyword token">return</SPAN> <SPAN class="keyword token">base</SPAN><SPAN class="punctuation token">.</SPAN><SPAN class="token function">Initialize</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
<SPAN class="punctuation token">}</SPAN>

<SPAN class="comment token">/// <summary></SPAN>
<SPAN class="comment token">/// Event delegate for the ActiveMapViewChangedEvent</SPAN>
<SPAN class="comment token">/// </summary></SPAN>
<SPAN class="keyword token">private</SPAN> <SPAN class="keyword token">void</SPAN> <SPAN class="token function">OnActiveMapViewChanged</SPAN><SPAN class="punctuation token">(</SPAN>ActiveMapViewChangedEventArgs args<SPAN class="punctuation token">)</SPAN>
<SPAN class="punctuation token">{</SPAN>
  <SPAN class="comment token">// get the button and change the caption</SPAN>
  <SPAN class="comment token">// button's id from config.daml: DynamicButtonChange_ButtonMapLoaded</SPAN>
  <SPAN class="keyword token">var</SPAN> plugin <SPAN class="operator token">=</SPAN> FrameworkApplication<SPAN class="punctuation token">.</SPAN><SPAN class="token function">GetPlugInWrapper</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="string token">"DynamicButtonChange_ButtonMapLoaded"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN>
  <SPAN class="keyword token">if</SPAN> <SPAN class="punctuation token">(</SPAN>args<SPAN class="punctuation token">.</SPAN>IncomingView <SPAN class="operator token">==</SPAN> <SPAN class="keyword token">null</SPAN><SPAN class="punctuation token">)</SPAN>
  <SPAN class="punctuation token">{</SPAN>
    plugin<SPAN class="punctuation token">.</SPAN>Caption <SPAN class="operator token">=</SPAN> <SPAN class="string token">"No Mapview"</SPAN><SPAN class="punctuation token">;</SPAN>
    <SPAN class="comment token">// plugin.LargeImage = ...</SPAN>
    <SPAN class="keyword token">return</SPAN><SPAN class="punctuation token">;</SPAN>
  <SPAN class="punctuation token">}</SPAN>
  plugin<SPAN class="punctuation token">.</SPAN>Caption <SPAN class="operator token">=</SPAN> <SPAN class="string token">"Active Mapview"</SPAN><SPAN class="punctuation token">;</SPAN>
  <SPAN class="comment token">// plugin.LargeImage = ...</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>

Anonymous User

Thank for your reply Wolfgang Kaiser‌,

It seems, I shall need to explain full scenario.

The one I want to achieve is that when user load/open the project, If the active view is map view, based on the certain condition the ribbon bar button will have different image and captions.

Related to the tab group changing colour post you answer before, I have to determine condition and switch the tab group as well.

I have no idea how to retrieve the specific ribbon button instance from Module instance, I manage the changing of button image and caption in the button class instance itself. So the condition/state for managing switching tab group and switching the image and caption of the ribbon button are the same.

And upon ribbon button click, the message result of those conditional check shall display.

So I tried and initialised the button instance once the module is initialized. (That I want to achieve)

But right now, I add the boolean switch in module class to monitor button instance is initiated. Before button initiated, all the task to do checking condition/state is performed in module instance (of course button image/caption will not manage). So I did turn on autoload to true for the module as well.

Any advice?

Wolf

Hi Than,

You can look here for an explanation: https://github.com/Esri/arcgis-pro-sdk/wiki/ProConcepts-Framework#jit-loading In essence Pro is using JIT (Just in time) loading to make Pro be more responsive at startup. However, if you need your add-in to start with Pro then you can change the autoLoad attribute of the module tag to "true" in your config.daml:

<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>yourmoduleId<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>...<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>...<SPAN class="punctuation token">"</SPAN></SPAN><SPAN class="punctuation token">></SPAN></SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN></SPAN>

Rejoindre la conversation

Les membres connectés peuvent publier, suivre les mises à jour, et plus encore. Nouveau ici ? Inscrivez-vous gratuitement.

Liens rapides

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