Question

Call code in VSTO ribbon from VBA (Word)

Asked by: thor_ostergaard

Hi,
I have a VSTO Ribbon written in Visual Studio 2008. This ribbon will be installed on all computers on our network. As part of the ribbon I have some functions.
Is it possible to call these functions from Word macro enabled templates without adding the templates the Ribbon project?
If yes - how do I do it?

This Question has been solved and asker verified All Experts Exchange premium technology solutions are available to subscription members.

Subscribe now for full access to Experts Exchange and get

Instant Access to this Solution

  • Plus...
  • 30 Day FREE access, no risk, no obligation
  • Collaborate with the world's top tech experts
  • Unlimited access to our exclusive solution database
  • Never be left without tech help again

Subscribe Now

Asked On
2009-10-26 at 04:28:20ID24843112
Tags

VSTO

,

Ribbon

,

Word

,

VBA

Topics

VSTO

,

Microsoft Word

,

Microsoft Excel Spreadsheet Software

Participating Experts
3
Points
500
Comments
14

Trusted by hundreds of thousands everyday for fast, accurate and reliable tech support.

  • "The time we save is the biggest benefit of Experts Exchange to Warner Bros. What could take multiple guys 2 hours or more each to find is accessed in around 15 minutes on Experts Exchange." Mike Kapnisakis, Warner Bros.
  • "Our team likes having a resource that is more secure than just using Google and most experts using this service really know their stuff. It's nice to look here first versus using Google." Dayna Sellner, Lockheed Martin
  • "Anytime that I've been stumped with a problem, 9 out of 10 times Experts Exchange has either the accepted solution or an open discussion of the potential solution to the problem." Kenny Red, eBay Inc.

See what Experts Exchange can do for you.

Got a question?

We've got the answer.

Experts Exchange has been collecting answers to technology questions since 1996…3 million and counting! If you have a question, chances are we already have your answer.

Screenshot of Experts Exchange Knowledgebase

Need individual assistance?

Our experts are ready to help.

If you can't find the exact answer you're looking for, ask our exclusive community of 50,000 experts. You’ll get a personalized answer from a trusted professional.

Screenshot of Experts Exchange Knowledgebase

Want to learn from the best?

Read articles from industry experts.

Thousands of free tech tips, tricks, how-to’s and tutorials are available in our peer reviewed articles section. See for yourself how smart our experts are, no login required.

Screenshot of an Article

Working on a long term project?

Store your work and research.

Save solutions to your questions, answers you’ve discovered through searching plus helpful articles in your personal knowledgebase for easy future access.

Screenshot of Experts Exchange Knowledgebase

Access the answers to your technology questions today.

Subscribe Now

30-day free trial. Register in 60 seconds.

What Makes Experts Exchange Unique?

Members of the expert community talk about why the experience at Experts Exchange is different than what you will find anywhere else.

Trusted by the world's most respected brands.

image of each brand's logo

Faithfully serving IT professionals since 1996.

Experts Exchange Logo

Try it out and discover for yourself.

Subscribe Now

30-day free trial. Register in 60 seconds.

Related Solutions

  1. Where can I find VBA specific info on creating a custom rib…
    This is something I'll have to figure out for myself, but I need to get pointed in the right direction. Here's what I know ... it's a short list. - I have to create and XML file that defines the ribbon, setting "Start From Scratch as True/False. - I have to open the DOTM...
  2. VBA to minimize the ribbon
    I need some VBA code to set the ribbon to minimize in Access 2007. I'm rolling out my db and the user's won't need the ribbon for 99% of their work. Is there a way to minimize the ribbon with VBA? If so, can someone supply me with the code.
  3. How do I create a Word 2007 Template with a customize…
    Hello everyone, I have been tasked to create a Word Template file that needs a custom ribbon. There is code in the template. I've been searching the Web and EE to look for the correct path to go down. There seems to be a number of solutions that people are disc...
  4. PowerPoint 2007 Template Ribbon Macro won't run
    I'm a self-taught VBA programmer, having done some fancy automation with Word 2007 templates, now starting to do the same in PowerPoint 2007. I have a .potm template with several VBA macros, and a custom ribbon (built with MS Office Custom UI Editor) with buttons that run ...
  5. How do I Create an Excel Add-In that Adds Buttons to the …
    What are the basic steps (and perhaps VB code snippits) that allow me to add a couple buttons to a new tab on the Excel 2007 ribbon that call VBA subroutines when clicked? The VBA subroutines are in the Personal.xlsb, but perform actions on the active workbook. How do I dep...

Free Tech Articles

  1. WARNING: 5 Reasons why you should NEVER fix a computer for free.
    It is in our nature to love the puzzle. We are obsessed. The lot of us. We love puzzles. We love the challenge. We thrive on finding the answer. We hate disarray. It bothers us deep in our soul. W...
  2. SCCM OSD Basic troubleshooting
    SCCM 2007 OSD is a fantastic way to deploy operating systems, however, like most things SCCM issues can sometimes be difficult to resolve due to the sheer volume of logs to sift through and the dispe...
  3. Migrate Small Business Server 2003 to Exchange 2010 and Windows 2008 R2
    This guide is intended to provide step by step instructions on how to migrate from Small Business Server 2003 to Windows 2008 R2 with Exchange 2010. For this migration to work you will need the fo...
  4. Create a Win7 Gadget
    This article shows you how to create a simple "Gadget" -- a sort of mini-application supported by Windows 7 and Vista. Gadgets can be dropped anywhere on the desktop to provide instant information, ...
  5. Outlook continually prompting for username and password
    There have been a lot of questions recently regarding Outlook prompting for a username and password whilst using Exchange 2007. There are a few reasons why this would happen and I will try to cover t...
  6. Backup Exchange 2010 Information Store using Windows Backup
    There seems to be quite a lot of confusion around the ability to backup Exchange 2010 using the built in Windows Backup feature. This stems from the omission of this feature prior to Exchange 2007 s...

Cloud Class Webinars

  1. Avoiding Bugs in Microsoft Access
    Alison Balter takes and in-depth look at avoiding bugs in Access. In this webinar you will learn about using the immediate window to debug your applications, invoking the debugger, using breakpoints to troubleshoot, stepping through code, setting the next statement to execute, ...
  2. Top 10 Best New Features in Visio 2010
    Scott Helmers gives live demonstrations of the top 10 new features in Visio 2010. This webinar will teach you how to create compelling diagrams by adding shapes to the page with a single click, linking the shapes in a diagram to data in Excel (or SQL Server, or SharePoint), ...
  3. IT Consultant Business Secrets Revealed
    Michael Munger, Experts Exchange tech pro and IT consultant, pulls back the curtain on his very successful businesses and answers question on every IT consultant and business owner should know about. He shares secrets on what he did to solve the 5 most common problems in IT, ...
  4. Disaster Recovery and Business Continuity
    Quest CTO, Mike Billon, gives an overview of the steps involved in building a dunamic disaster recovery plan. Through case studies and an examination of software/hardware tooles for monitoring and testing, you'll gain a better understandin of where you are, where you want ...
  5. Organize Your Visio Diagrams with Containers and Lists
    Scott Helmers uses cross functional flowcharts, wireframe diagrams, data graphic legends and seating charts to teach you: how to ustilize all three new structured diagram components in Visio 2010, the best practices for organizeing shapes in previous version of Visio, how to organize ...
  6. How to Us Objects, Properties, Events and Methods in Microsoft Access
    Alison Dalter gives an in-depbth look at objects, properties, events and methods in Microsoft Access. In this webinar you will learn about using the object browser, referring to objects, working with properties and methods, working with object variables, understanding the ...

Join the Community

Give a Little. Get a Lot.

Join the community of experts here and help other tech pros by answering question in your area of expertise. You can earn FREE access to all Experts Exchange's premium features and resources.

Join the Community

Answers

 

by: thor_ostergaardPosted on 2009-10-26 at 08:45:34ID: 25663431

Sorry, but I can't see any description on how to use functions in the ribbon code from Word templates.

I would love to see more specific examples.

(I do know how to Google)

 

by: mas_oz2003Posted on 2009-10-26 at 14:52:17ID: 25667319

Yes it is possible
Let button1 be a button on the ribbon
Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) Handles Button1.Click
        ' Myshow is the macro name written in the word template
        Globals.ThisDocument.Application.Run("Myshow")
End Sub

 

by: thor_ostergaardPosted on 2009-10-26 at 23:56:21ID: 25669617

No  - it's the other way. I want to call functions in VSTO *from* VBA

 

by: xenacodePosted on 2009-10-27 at 03:18:35ID: 25670700

You can do this providing your VSTO add-in exposes its functionality correctly.

Within your VBA you can access the COMAddIns property of the Application object. This is a collection of objects representing the loaded add-ins. Each of these objects has a property called Object of type Object which you can access from within your VSTO solution.

Inside your VSTO ThisAddIn class, override the RequestComAddInAutomationService function like this:

Protected Overrides Function RequestComAddInAutomationService() As Object
      Dim myAddIn = MyClassThatDoesStuff
        Return myAddIn
End Function

Create a public class (in the above code, it's MyClassThatDoesStuff) in your VSTO solution that exposes the public methods that you want to be able to call from your VBA.

So now, in your VBA code you can find the Addin like this:

For Each addIn As COMAddIn In Application.COMAddIns
      If addIn.ProgId = "MyVSTOAddin.Whatever" AndAlso addIn.Object IsNot Nothing Then
            'call some methods
            addIn.Object.MyMethod
      End If
Next


(where "MyVSTOAddin.Whatever" is your VSTO AddIn name.)

I hope that makes sense. If not, let me know.


Pete
Xenacode Ltd

 

by: thor_ostergaardPosted on 2009-10-27 at 09:44:13ID: 25674573

Like this?
First snippet is from VSTO and the last from Word VBA.
I think I find the right AddIn, but get an "Object variable or With block variable not set"
What's wrong?

Public Class ThisAddIn
    Protected Overrides Function RequestComAddInAutomationService() As Object
        Dim myAddIn = New Testing()
        Return myAddIn
    End Function
 
    Public Class Testing
        Sub ThorTest()
            MsgBox("It works!!")
        End Sub
    End Class
End Class
 
=================================
 
Sub Testing()
    Dim AddIn As COMAddIn
    For Each AddIn In Application.COMAddIns
        MsgBox AddIn.ProgID
        If AddIn.ProgID = "CPHRibbon" And Not IsNull(AddIn.Object) Then
            AddIn.Object.ThorTest
        End If
    Next
End Sub

                                              
1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:
18:
19:
20:
21:
22:
23:
24:

Select allOpen in new window

 

by: xenacodePosted on 2009-10-27 at 10:02:21ID: 25674785

You will need to keep a reference to the Testing object that you create within ThisAddIn or it will be Null/Nothing when the VBA tries to call the ThorTest method. My sample didn't show that so sorry for not being specific. Also try moving the Testing class outside of class ThisAddIn like so:

Public Class ThisAddIn

      Private myTesting as Testing

      Protected Overrides Function RequestComAddInAutomationService() As Object
                myTesting  = New Testing()
                Return myTesting  
      End Function

End Class

Public Class Testing
        Sub ThorTest()
            MsgBox("It works!!")
        End Sub
End Class

I think that should do it.

Pete

 

by: thor_ostergaardPosted on 2009-10-27 at 12:04:30ID: 25676127

Not really. My code is now as below but I still get  "Object variable or With block variable not set"
Is there a way to debug from here?

Public Class ThisAddIn
    Private Sub ThisAddIn_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup
    End Sub
    Private Sub ThisAddIn_Shutdown(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Shutdown
    End Sub
 
    Private myTesting As Testing
 
    Protected Overrides Function RequestComAddInAutomationService() As Object
        myTesting = New Testing()
        Return myTesting
    End Function
End Class
 
Public Class Testing
    Sub ThorTest()
        MsgBox("It works!!")
    End Sub
End Class
 
===========
 
Sub Testing()
    Dim AddIn As COMAddIn
    For Each AddIn In Application.COMAddIns
        MsgBox AddIn.ProgID
        If AddIn.ProgID = "CPHRibbon" And Not IsNull(AddIn.Object) Then
            AddIn.Object.ThorTest
        End If
    Next
End Sub
                                              
1:
2:
3:
4:
5:
6:
7:
8:
9:
10:
11:
12:
13:
14:
15:
16:
17:
18:
19:
20:
21:
22:
23:
24:
25:
26:
27:
28:
29:
30:
31:

Select allOpen in new window

 

by: xenacodePosted on 2009-10-27 at 12:57:47ID: 25676716

Can you check if the addin is actually loaded? Perhaps you could add a line into the VBA like this to check if the add-in has been found in the COMAddIns collection:

Sub Testing()
    Dim AddIn As COMAddIn
    For Each AddIn In Application.COMAddIns
        MsgBox AddIn.ProgID
        If AddIn.ProgID = "CPHRibbon" And Not IsNull(AddIn.Object) Then
            MsgBox ("Found the addin")
            AddIn.Object.ThorTest
        End If
    Next
End Sub

and perhaps another in the addin startup to confirm your VSTO code is running:

Private Sub ThisAddIn_Startup(ByVal sender As Object, ByVal e As System.EventArgs) _
   Handles Me.Startup
       MsgBox ("Addin starting")
End Sub

Pete

 

by: thor_ostergaardPosted on 2009-10-27 at 13:04:49ID: 25676818

AddIn is starting in VSTO and AddIn is found in VBA :-(

 

by: thor_ostergaardPosted on 2009-10-27 at 23:56:21ID: 25680518

But still "Object variable or With block variable not set"

 

by: xenacodePosted on 2009-10-28 at 01:25:41ID: 25680892

One last thing I should have mentioned. You need to make the Testing class COM-visible. You can add this class attribute like so:

<System.Runtime.InteropServices.ComVisibleAttribute(True)> _
Public Class Testing
...

Now try it!

Pete

 

by: xenacodePosted on 2009-10-28 at 02:00:54ID: 25681082

I tested it this time :o)

 

by: thor_ostergaardPosted on 2009-10-28 at 02:43:24ID: 25681278

Thanks :-)

20120131-EE-VQP-002

3 Ways to Join

30-Day Free Trial

The Experts

98% positive feedback on 31,087 answers since March 2000. angeliii is a Microsoft Most Valuable Professional for his work with MS SQL Server & Develoment.

He has also proven his knowledge of Visual Basic Programming, PHP Scripting and Oracle Databases.

The Experts

97% positive feedback on 10,752 answers since July 2000. lrmoore has more than 18 years experience in the networking industry.

The six-time Mircosoft MVPs specialties include firewalls, virtual private networking, and network management.

Testimonials

"...and excellent source for support... Kind of like having your very own IT dept." Electriciansnet

Testimonials

"I was apprehensive at signing up at first. However... it has already made my life as an IT administrator much easier." JaCrews

Testimonials

"WOW! You guys have great, active, and knowledgeable people on here." moore50

Business Clients

Business Clients

In the Press

"If you’ve got a question... Experts Exchange can supply an answer.”

In the Press

"...an invaluable aid for both IT professionals and those who require tech support."

In the Press

"where IT professionals provide quick answers on just about any topic"

Business Account Plans

Loading Advertisement...