Is there a way to get a reference to control on a custom Ribbon?

GustavoCruz

Hi,

On our AddIn we have an EditBox on our custom Ribbon. I would like to access its Text from a DockPane.

I was expecting something similar to what's in place for DockPanes (FrameworkApplication.DockPaneManager.Find("the id of the dockpane")) to exist but can't find anything on the API to get a reference to a control on the Ribbon.

Thanks

Wolf

In theory you can use this snippet:

<SPAN class="comment token">// Test_EditBox is the Id of the editBox in config.daml:</SPAN>
<SPAN class="keyword token">var</SPAN> plugin <SPAN class="operator token">=</SPAN> FrameworkApplication<SPAN class="punctuation token">.</SPAN>GetPlugInWrapper <SPAN class="punctuation token">(</SPAN><SPAN class="string token">"Test_EditBox"</SPAN><SPAN class="punctuation token">)</SPAN><SPAN class="punctuation token">;</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN><SPAN>‍</SPAN></SPAN>

however, currently there is a limitation in the API that doesn't allow you to access the returned plugin wrapper which is of the type: ArcGIS.Desktop.Framework.Wrappers.EditBoxWrapper, not accessible via the API.

So the best way to access the text from anywhere is to create a static string property in the Module class and set that property with the text each time the text is changed:

Module1.cs add:

<SPAN class="keyword token">internal</SPAN> <SPAN class="keyword token">static</SPAN> <SPAN class="keyword token">string</SPAN> EditText <SPAN class="punctuation token">{</SPAN> <SPAN class="keyword token">get</SPAN><SPAN class="punctuation token">;</SPAN> <SPAN class="keyword token">set</SPAN><SPAN class="punctuation token">;</SPAN> <SPAN class="punctuation token">}</SPAN><SPAN class="line-numbers-rows"><SPAN>‍</SPAN></SPAN>

To your EditBox class you add these overrides depending on your input trigger preference:

<SPAN class="comment token">/// <summary></SPAN>
<SPAN class="comment token">/// Called when the 'Enter' key is pressed inside this control or when the control loses keyboard focus.</SPAN>
<SPAN class="comment token">/// </summary></SPAN>
<SPAN class="keyword token">protected</SPAN> <SPAN class="keyword token">override</SPAN> <SPAN class="keyword token">void</SPAN> <SPAN class="token function">OnEnter</SPAN><SPAN class="punctuation token">(</SPAN><SPAN class="punctuation token">)</SPAN>
<SPAN class="punctuation token">{</SPAN>
  <SPAN class="comment token">// Passes the current Text in the EditBox to the global parameter in Module1.</SPAN>
  Module1<SPAN class="punctuation token">.</SPAN>EditText <SPAN class="operator token">=</SPAN> Text<SPAN class="punctuation token">;</SPAN>
<SPAN class="punctuation token">}</SPAN>

<SPAN class="keyword token">protected</SPAN> <SPAN class="keyword token">override</SPAN> <SPAN class="keyword token">void</SPAN> <SPAN class="token function">OnLostKeyboardFocus</SPAN><SPAN class="punctuation token">(</SPAN>KeyboardFocusChangedEventArgs e<SPAN class="punctuation token">)</SPAN>
<SPAN class="punctuation token">{</SPAN>
  <SPAN class="comment token">// Passes the current Text in the EditBox to the global parameter in Module1.</SPAN>
  Module1<SPAN class="punctuation token">.</SPAN>EditText <SPAN class="operator token">=</SPAN> Text<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>

If you prefer events you can also implement an OnEditBoxChanged event in you EditBox class.

Cluster Radius Slider.png