topic Re: Addin Button - Icon AND text (Image and Caption) how? in ArcObjects SDK Questions

Addin Button - Icon AND text (Image and Caption) how?

MichaelRobb — Thu, 07 Apr 2011 14:50:13 GMT

Hi everyone,

Simple but frustrating problem:
Prior to arcAddinx, there was no problem choosing to have Image / Text or Both for any button when a toolbar was loaded using the following code below triggered off the ENABLED using ESRICommandStyles. (IToolbarDef)

        Public Sub SetAsIconAndText()

                ' Make sure button is showing Icon And Text
                Dim pUID As New UID
                pUID.Value = "{F53B91E1-C520-41a7-941C-686AA071D1A2}"  ' Toolbar GUID

            Dim pCommandBar As ESRI.ArcGIS.Framework.ICommandBar
            pCommandBar = m_application.Document.CommandBars.Find(pUID, True, False)

            Dim i As Integer
            If Not pCommandBar Is Nothing Then
                For i = 0 To pCommandBar.Count - 1
                    If pCommandBar.Item(i).Name = "FocusCorp_FocusEllipse" Then ' use the Property NAME of the button
                        pCommandBar.Item(i).Style = esriCommandStyles.esriCommandStyleIconAndText
                        Exit For
                    End If
                Next
            End If


        End Sub

I am aware that a user can AFTER the fact customize, but why would ESRI have left this functionality out with Addin XML?

Is there anyone that has found the means to control what each button displays on created toolbars when using Addins as far as Image and Caption?

Suggestions appreciated,

vb.net

Thanks

Re: Addin Button - Icon AND text (Image and Caption) how?

SoniaScialanca — Sat, 11 Dec 2021 19:47:24 GMT

Hi Mike,
I'm just trying in these days to port some custom functionalities from 9.3.1 to 10, using add ins.
To change a command style I'm using your same method with only one difference: the UID.
The code is C#:

UIDClass p_UID = new UIDClass();
p_UID.Value = ThisAddIn.IDs.<ButtonID>;
ICommandItem p_CommandItemLogin = ((IDocument)ArcMap.Document).CommandBars.Find(p_UID, false, true) as ICommandItem;
p_CommandItemLogin.Style = ESRI.ArcGIS.SystemUI.esriCommandStyles.esriCommandStyleIconAndText;
p_CommandItemLogin.Refresh();

The ButtonID is the "id" value in the tag "Button", in the config.esriaddinx, but there's no need to write it, you should find it as a static value from ThisAddIn.IDs.

Instead, I'm looking for a method to change the image of a button after some actions.
Something like the old:

base.m_bitmap = new Bitmap(GetType(), bitmapResourceName);

Can you help me for this problem?
Thank you.

Sonia

Re: Addin Button - Icon AND text (Image and Caption) how?

DavidWilcox — Mon, 11 Jul 2011 19:47:06 GMT

Has anyone found a way to dynamically modify the addin button icon or text?

Thanks!

- Dave

Re: Addin Button - Icon AND text (Image and Caption) how?

SoniaScialanca — Mon, 01 Aug 2011 13:38:39 GMT

I found this:

http://gis.stackexchange.com/questions/1297/can-you-programmatically-change-the-button-image-for-a-esri-arcgis-desktop-addins

and it works for me! 😄

Re: Addin Button - Icon AND text (Image and Caption) how?

MichaelRobb — Tue, 02 Aug 2011 15:45:21 GMT

I found this:

http://gis.stackexchange.com/questions/1297/can-you-programmatically-change-the-button-image-for-a-esri-arcgis-desktop-addins

and it works for me! 😄

perhaps I should have clarified...
I am aware of Caption and all XML variables within the esriaddinx config file... Caption gives the text under the Customize Mode >Commands window, as it should.

The question was... how does one, when creating a toolbar with buttons, have an IMAGE and TEXT (text for the image) appear on the toolbar ** using Addins? (Have no problems using dll old method with Command Style
(I only found a way to use drop downs and have image AND text together, but not simply a button on a toolbar...

Once the button is on the bar, the user then MUST go to Customize >> Customize mode and right click on the image and click from DEFAULT to 'Image and Text' to have the button and Text both visible.

The question was, is there a way to have Button AND text show up on a toolbar as seen in the pic here, I have to manually change to have BOTH icon and text show on the toolbar as seen below for PrecisionXY example.

Re: Addin Button - Icon AND text (Image and Caption) how?

JeffreyHamblin — Sat, 11 Dec 2021 19:47:27 GMT

Hi Mike,

I believe you can achieve this in an extension as an addition to the way we handled the top menu in your other post: Modify-(add)-to-MAIN-Toolbar-with-Addinx-files.

Just call this little method in the same event handlers (sorry for the C#, but I'm sure you can convert it to vb.net easily):

private void SetButtonStyle()
{
    ICommandBars commandBars = ArcMap.Application.Document.CommandBars;
    ICommandItem commandItem = commandBars.Find(ThisAddIn.IDs.YourButtonClassNameHere, true, false);

    if (commandItem != null)
    {
        commandItem.Style = esriCommandStyles.esriCommandStyleIconAndText;
    }
}

Again, not thoroughly tested, but works for me on a quick test.

The code you included in your initial post was a big help.

Re: Addin Button - Icon AND text (Image and Caption) how?

MichaelRobb — Sat, 11 Dec 2021 19:47:30 GMT

This specifically was for a toolbar / buttons... so create an extention just to control the command styles? seems silly... let me see if that works...
you cant access THISaddin and look for that button as its not contained in the Extension addin. its in a separate addin.

How would one trigger on 'creation' when the Addin is added, its not possible is it?

The code below works, but never found a way to have it work on loading the toolbar.
OnClick - well, thats too late
OnUpdate ?
Sub Finalize?

    Public Sub SetAsIconAndText()

        ' Make sure button is showing Icon And Text
     '   Dim pUID As New UID  'not needed
     '   pUID.Value = My.ThisAddIn.AddInID ' ' Toolbar GUID ' not needed

        Dim pCommandItem As ESRI.ArcGIS.Framework.ICommandItem
        pCommandItem = My.ArcMap.Application.Document.CommandBars.Find(My.ThisAddIn.IDs.PrecisionXYButton, true, false)

        pCommandItem.Style = ESRI.ArcGIS.SystemUI.esriCommandStyles.esriCommandStyleIconAndText



    End Sub

jeff... you were a ton help in getting me going with creating Root Menu drop down items and pointing to other buttons/commands btw...

Re: Addin Button - Icon AND text (Image and Caption) how?

MichaelRobb — Sat, 11 Dec 2021 19:47:32 GMT

Just to summarize...

This does work, if a) you build a toolbar with commands (buttons) ...
you must then build an EXTENSION to use the Events.NewDocument and Events.OpenDocument.

Currently I do not know of a way of adjusting the Command style through the Toolbar/buttons added in a specific Addin file. - the ORIGINAL Question.

then find the UID value for that specific command Item...
like so...

    Public Sub SetAsIconAndText()

        ' Make sure button is showing Icon And Text
        Dim pUID As New UID
        pUID.Value = "{6298A204-AD3A-9573-D5E7-E8952250BA36}"  ' Toolbar GUID"

        Dim pCommandItem As ESRI.ArcGIS.Framework.ICommandItem
        pCommandItem = My.ArcMap.Application.Document.CommandBars.Find(pUID, True, False)

        pCommandItem.Style = ESRI.ArcGIS.SystemUI.esriCommandStyles.esriCommandStyleTextOnly



    End Sub

Re: Addin Button - Icon AND text (Image and Caption) how?

DubravkoAntonic — Tue, 02 Aug 2011 19:02:10 GMT

I'm not sure this can be done because...
AddIns are not loaded at Application StartUp , Delay loading, but on Button click.
http://help.arcgis.com/en/sdk/10.0/arcobjects_net/conceptualhelp/index.html#/Advanced_add_in_concepts/0001000004n7000000/

ArcMap in general prefers to make UI changes after IApplicationStatus.Initialized which you can not trap because your AddIn is not running.

I didn't tested but it looks to me ArcMap is saving AddIn settings in Normal.mxt. And if I'm right then it can't be done without any kind of extension that is detecting and modifying the ArcMap.

Regards Dubravko Antoni�?

Re: Addin Button - Icon AND text (Image and Caption) how?

SoniaScialanca — Wed, 03 Aug 2011 08:00:39 GMT

The code below works, but never found a way to have it work on loading the toolbar.
OnClick - well, thats too late
OnUpdate ?
Sub Finalize?

I'm not sure if it's completely right, but I've used this code inside the OnUpdate method and it works for me, I've no need to change the style manually.
Note that the OnUpdate method is called many times during the start up of ArcMap, but the first few times, even if the object (button) exists, it is not really initialized, due to the delay mentioned by dubravko.antonic:

AddIns are not loaded at Application StartUp , Delay loading...

So, only after the button it's really loaded the code works and for this reason I decided to use it inside OnUpdate method: despite this delay I can see the style changed even if I don't click on the button. (in config.esriaddinx I also set the OnDemand on false).

Re: Addin Button - Icon AND text (Image and Caption) how?

MichaelRobb — Wed, 03 Aug 2011 18:14:14 GMT

I'm not sure if it's completely right, but I've used this code inside the OnUpdate method and it works for me, I've no need to change the style manually.
Note that the OnUpdate method is called many times during the start up of ArcMap, but the first few .

No, OnUpdate is Not called when a NEW arcmap session is opened. I tried several times with a fresh Addin, then debug or run arc, there was no OnUpdate trigger, therefore, no adjustment to the command style.
OnUpdate was not triggered until you pressed the actual button, but a new Addin, toolbar shows up, and ONLY the icon shows up even with the code in Protected Overrides Sub OnUpdate(). OR if you were lucky to hit a framework OnUpdate run, used for example to check if an extension is enabled.

In debugging, was not stopped (break point) either when a fresh arc was opened meaning OnUpdate was never called on New Document.

There must be something you had done prior, or manually changed it at some point or just got lucky the framework called the OnUpdate. Change your code to be esriCommandStyleTextOnly and see if its ONLY text (and see if it changes), then change it to a different enum again and see if the change follows.

No Overrides from a button perspective will work.
OnUpdate is random and multiple times called by the framework... If it manages to update the button, you hit a 'right time' scenario, and you would be running the code over and over.
When I set OnDemand = false in the esriaddinx, I cant even get Arc to load, it just crashes... i believe due to the command not initialized yet, and already trying to change the commands style.

The only proper method is to add an extension and run on NEW and OPEN document events, to control the command style as stated prior.
this ensures the commandstyle change WILL occur right at startup.

ref:
http://help.arcgis.com/en/sdk/10.0/arcobjects_net/componenthelp/index.html#//001v000001qw000000

Re: Addin Button - Icon AND text (Image and Caption) how?

MichaelRobb — Wed, 03 Aug 2011 18:47:56 GMT

The correct way:

Using an extension:

Here is the Class.vb called in the esriaddinx:

[HTML]
Imports System.Windows.Forms

Imports ESRI.ArcGIS.esriSystem
Imports ESRI.ArcGIS.Framework

Public Class YOUREXTENSIONClassName

    Inherits ESRI.ArcGIS.Desktop.AddIns.Extension
'Not needed for this example
' Private c_mainMenuID As String = "{1E739F59-E45F-11D1-9496-080009EEBECB}" ' Main menubar

    Public Sub New()

    End Sub

    Protected Overrides Sub OnStartup()

        WireDocumentEvents()

    End Sub

    Protected Overrides Sub OnShutdown()

    End Sub

    Private Sub WireDocumentEvents()

        AddHandler My.ArcMap.Events.NewDocument, AddressOf ArcMapNewDocument
        AddHandler My.ArcMap.Events.OpenDocument, AddressOf ArcMapOpenDocument

    End Sub

   Private Sub ArcMapNewDocument()

        Try

          SetAsIconAndText(Your UID OR ClassID value, ESRI.ArcGIS.SystemUI.esriCommandStyles.esriCommandStyleTextOnly )

        Catch ex As Exception
            MessageBox.Show(ex.Message & vbNewLine & "Details: " & ex.StackTrace, "", MessageBoxButtons.OK, MessageBoxIcon.Asterisk)

        End Try

    End Sub

Private Sub ArcMapOpenDocument()

        Try

           SetAsIconAndText(Your UID OR ClassID value, ESRI.ArcGIS.SystemUI.esriCommandStyles.esriCommandStyleTextOnly )

        Catch ex As Exception
            MessageBox.Show(ex.Message & vbNewLine & "Details: " & ex.StackTrace, "", MessageBoxButtons.OK, MessageBoxIcon.Asterisk)

        End Try

    End Sub

Public Sub SetAsIconAndText(ByVal UIDValue As String, ByVal CommandStyle As ESRI.ArcGIS.SystemUI.esriCommandStyles)

        'control text or Text and icon or icon only
        Dim pUID As New UID
        pUID.Value = UIDValue 'YOUR COMMAND BUTTON UID VALUE OR ButtonID name in esriaddinx file of that Addin.

        Dim pCommandItem As ESRI.ArcGIS.Framework.ICommandItem
        pCommandItem = My.ArcMap.Application.Document.CommandBars.Find(pUID, True, False)

        pCommandItem.Style = CommandStyle

    End Sub
End Class

[/HTML]

Re: Addin Button - Icon AND text (Image and Caption) how?

DubravkoAntonic — Wed, 03 Aug 2011 19:14:48 GMT

Didn't try for ArcMap 10 but in prior versions 9.3.1 and earlier ,for each button, properties Enabled and Checked was called on regular basis, like once a second, if that can help you.

regards Dubravko

Re: Addin Button - Icon AND text (Image and Caption) how?

SoniaScialanca — Thu, 04 Aug 2011 07:21:54 GMT

My personal experience: I also tried with the extension and when I put the code inside that class the button object was not completely loaded and the result was that I got a button with only the icon, the first time the extension was initialized.
I had to uncheck/check the extension to make that code work and to get the style changed.
This is why I moved the code into the OnUpdate method and when I debug I can see this method called, I don't now why my and your addin work different... 😞