Click here to Skip to main content
Click here to Skip to main content

Microsoft Outlook Add-in Tutorial - 2: Addding Events to Button

, 11 Jun 2004
Rate this:
Please Sign up or sign in to vote.
This adds an Event Handler to the Button added in first tutorial.

Introduction

Adding an Event Handler for the Button created in previous tutorial

In the previous tutorials, we have seen how to add a toolbar and thus create a button in Microsoft Outlook. Now, in this tutorial, we will see how to invoke an event handler for the button, or in terms of COM, how to advise the Button event!.

The idea behind this tutorial is simple, we need to display a message box saying, "Button Clicked", when we click on the button created. For this, we have to capture the Button Click Event, i.e., CommandBar Events. The disp interface responsible for this is _CommandBarButtonEvents. So now, if we implement this sink interface that will be called by the event source, then our job is over.

IDispEventSimpleImpl<>

So, here we have to create a connection point between our button and interface in simple words. The IDispEventSimpleImpl<> interface provides the connection points for an ATL COM Object. It is also used to implement an event dispinterface. Now, we have to derive our class from this interface. This is done as follows:

class ATL_NO_VTABLE CAddin : 
    public CComObjectRootEx<CComSingleThreadModel>,
    public CComCoClass<CAddin, &CLSID_Addin>,
    public IDispatchImpl<IAddin, &IID_IAddin, &LIBID_OUTLOOKADDINLib>,
    public IDispatchImpl<_IDTExtensibility2, 
        &IID__IDTExtensibility2, &LIBID_AddInDesignerObjects>,
    //the derivation is done here
    public IDispEventSimpleImpl<1,CAddin, 
        &__uuidof(Office::_CommandBarButtonEvents)> 
Parameters:
  1. The first parameter is a unique identifier for the source object.
  2. The second parameter is the user's class, so here we have CAddin.
  3. The third parameter is pointer to IID of the event dispinterface by this class.
  4. Here our dispinterface is Office::_CommandBarButtonEvents. For help, please refer Microsoft Outlook Object Model.

A Simple Shortcut:

Now, we do a simple shortcut to make our job easier. We add this code before the constructor in our file:

public:
//the added code is here
 typedef IDispEventSimpleImpl</*nID =*/ 1, 
    CAddin, &__uuidof(Office::_CommandBarButtonEvents)> CommandButton1Events;
 CAddin()
 {
 }

As we can see, this can help in advising our sink since we are doing typedef here. If you get confused here, please do feel free to proceed to the next step.

Sink Entry:

In order to move with sinks, we have to have entries for our event notifications to be handled by their proper functions as we have for Messages in MFC and Win32.

So, we need to enter the SINK ENTRY as follows after END_COM_MAP() macro.

BEGIN_SINK_MAP(CAddin)
SINK_ENTRY_INFO(1, __uuidof(Office::_CommandBarButtonEvents),0x01, 
                               OnClickButton, &OnClickButtonInfo)
END_SINK_MAP() 
in SINK_ENTRY_INFO

We have specified our unique identifier, IID identifying the dispatch interface, dispid identifying the specified event, name of the event handler function, and the last parameter corresponds to type information. This is provided in the form of ATL_FUNC_INFO structure. We do it in Addin.cpp file.

_ATL_FUNC_INFO OnClickButtonInfo = 
  {CC_STDCALL,VT_EMPTY,2,{VT_DISPATCH,VT_BYREF | VT_BOOL}}; 

Setting up our CallBack:

  1. We define our callback as follows:
    void __stdcall 
          OnClickButton(IDispatch * /*Office::_CommandBarButton**/ Ctrl, 
          VARIANT_BOOL * CancelDefault); 
  2. Next would be our declaration of our OnClickButton function which is added at the top of Addin.h.
    extern _ATL_FUNC_INFO OnClickButtonInfo;
  3. The next and final step is to write our function! So, here is the function, in Addin.cpp.
    void __stdcall CAddin::OnClickButton(IDispatch* Ctrl, 
                                    VARIANT_BOOL * CancelDefault)
    {
        MessageBox(NULL, "U Have Clicked Me, 
                                Friend", "OnClickButton", MB_OK);
    }

That's it....we have completed our second tutorial of getting a message box when we press the button...hmm...it looks so simple and sure it is.

Since this is my first step in writing tutorials, please do feel free to send your reviews to chakkaradeepcc@yahoo.com.

Credits:

  1. This tutorial was based on the idea of Amit Dey in his tutorial, Building an Office2K COM add-in with VC++/ATL.

    So all my thanks goes to Mr. Amit Dey who was 'the guru' for me to Add-ins.

  2. And I mention Igor Tandek of Microsoft Corporation for his great help in making me understand the Inner Concepts of Add-ins along with ATL COM.

A small request to Amit Dey....any contact number or address or mail-id?

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Share

About the Author

chakkaradeepcc
Software Developer
New Zealand New Zealand
Chakkaradeep, known as Chaks to his friends, hails from the Indian subcontinent.Having done his Masters in Software Engineering, he knows his way around a computer and has sound knowledge of Microsoft technologies.
 
Chaks is currently working as a Microsoft Developer @ New Zealand.
 
You can reach him via his blog - http://chakkaradeep.wordpress.com

Comments and Discussions

 
QuestionMore buttons make the addin class derivation more longer. Can we avoid deriving addin class from each button? Pinmemberravistrs5-Feb-09 2:26 
QuestionHow to get the DISPID of an event? Pinmemberlakshmi.dj@gmail.com7-Jan-09 1:07 
AnswerRe: How to get the DISPID of an event? PinmemberMember 440328015-Jan-09 3:39 
See msoutl.tli
For instance,
SINK_ENTRY_INFO(2, __uuidof(Outlook::ApplicationEvents_11), 0x0000FAB5, OnNewMailEx, &OnNewMailExInfo)
corresponds to
inline HRESULT Outlook::ApplicationEvents_11::NewMailEx ( _bstr_t EntryIDCollection ) {
return _com_dispatch_method(this, 0xfab5, DISPATCH_METHOD, VT_EMPTY, NULL,
L"\x0008", (BSTR)EntryIDCollection);
}
where second parameter of return method is a third parameter of SINK macro
GeneralDLL giving errors PinmemberCansu13-Nov-07 14:08 
GeneralPopup PinmemberLazyKancha30-Mar-06 23:49 
GeneralRe: Popup Pinmemberchaitanya shah9-Jul-07 19:58 
Questionuse VARIANT_BOOL * CancelDefault? Pinmemberlandmark_csl8-Mar-06 20:40 
AnswerRe: use VARIANT_BOOL * CancelDefault? Pinmemberchaitanya shah9-Jul-07 20:04 
Questionhow to add action event Pinmemberdevom29-Dec-04 19:15 
AnswerRe: how to add action event Pinmemberchaitanya shah9-Jul-07 20:07 
Questionhow to implement dispatch sink interface PinmemberVladimir Forsh14-Jun-04 23:14 
AnswerRe: how to implement dispatch sink interface Pinmemberchaitanya shah9-Jul-07 20:06 
GeneralSorry for the inconvenience PinsussChakkaradeep4-Jun-04 22:09 
GeneralWrong Link to Zip-File PinmemberKurt Muellner25-May-04 20:59 
GeneralRe: Wrong Link to Zip-File Pinmemberchaitanya shah9-Jul-07 20:09 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web02 | 2.8.140827.1 | Last Updated 12 Jun 2004
Article Copyright 2004 by chakkaradeepcc
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid