CommandBar by ID

[bpatra]

There are two CommandBar with name "Cell": one for the usual right click on a cell and one for the "PageBreakView" see this article. When passing to the method ExcelCommandBarUtil.LoadCommandBar an xml argument of the form

<commandBars xmlns='http://schemas.excel-dna.net/office/2003/01/commandbars' > 
  <commandBar name='Cell'>
  <button caption='Hello' enabled='true' onAction='SayHello'/>
  </commandBar>
</commandBars>"

the first CommandBar whose name is "Cell" is returned. We have found situations where this first CommandBar is the "Cell" for PageBreakView and not the usual one.

In this pull request we add the possibility to specify the id of the CommandBar to avoid such situations. If an attribute id is present then it will be used to retrieve the CommandBar instead of name. If no id attribute is present then the name is used as a fallback (to avoid breaking existing code). Note that the attribute name is mandatory in both cases.

Now if you want to retrieve the usual "Cell" CommandBar you can use its id 424.

<commandBars xmlns='http://schemas.excel-dna.net/office/2003/01/commandbars' > 
  <commandBar name='Cell' id='424'>
  <button caption='Hello' enabled='true' onAction='SayHello'/>
  </commandBar>
</commandBars>"

[govert]

Thank you - I'll have a look.

[govert]

Hi Benoit,
I'm a bit confused by the CommandBar.Id property that you're checking. Looking in the COM object model reference, it doesn't look like CommandBar actually has this property, rather CommandBarControl has an Id. I guess some CommandBars are actually CommandBarPopup controls, so they might have the Id property that way.
Do you think there's a way to put the Id property on CommandBarControl, which seems more correct, and still have your Id-lookup functionality?
-Govert

[adefalque]

Hi Govert,

Following your comment, and since I had the occasion to work with Benoit, I propose you the following modification to Benoit's code.

• Id property moved to CommandBarControl class
• Expose the Type property on CommandBar:class

        public MsoBarType Type
        {
            get
            {
                return (MsoBarType)ComObjectType.InvokeMember("Type", BindingFlags.GetProperty, null, ComObject, null);
            }
        }

• Changed GetCommandBarFromIdOrName code to:

...
            if (id != null)
            {
                string barId = id.Value;
                CommandBar bar = null;
                for (int i = 1; i <= excelApp.CommandBars.Count; i++)
                {
                    var currentBar = excelApp.CommandBars[i];
                    if (currentBar.Type == MsoBarType.msoBarTypePopup)
                    {
                        var currentBarPopup = new CommandBarPopup(currentBar.GetComObject());
                        if (currentBarPopup.Id == barId)
                        {
                            bar = currentBar;
                            break;
                        }
                    }
                }
                return bar;
            }
...

Does it look ok to you?

Alexandre

[govert]

Thanks Alexandre - I think that will be great.
I'll let you know when I've added it in the main repository on CodePlex.

[bpatra]

The remote branch commandBarByID benefits from these changes merging the pull request now should take the five commit the last one being made by Alexandre..

[govert]

OK - this is finally integrated. Sorry it took so long - I'm moving the main repository over to GitHub at last.