Home > Articles > Programming > Windows Programming

This chapter is from the book

Office Add-Ins

The second pattern used in Office development is the add-in pattern. This book will cover several types of Office add-ins. These include VSTO add-ins for Outlook, COM add-ins for Excel and Word, and Automation add-ins for Excel:

  • VSTO add-ins for Outlook. This new VSTO 2005 feature makes it extremely easy to create an add-in for Outlook 2003. The model is the most ".NET" of all the add-in models and is very similar to the VSTO 2005 code behind model for documents. Chapter 23 describes this model in detail.
  • COM add-ins for Excel and Word. A C# class in a class library project can implement the IDTExtensibility2 interface and register in the registry as a COM object and COM add-in. Through COM interop, Office creates the C# class and talks to it. Chapter 24 describes the creation of COM add-ins and some issues that make COM add-in development problematic.
  • Automation add-ins for Excel. These managed classes expose public functions that Excel can use in formulas. The C# class must register in the registry as a COM object. Through COM interop, Excel can create an automation add-in and use its public methods in formulas. Automation add-ins and their use in Excel formulas are discussed in Chapter 3.

There are some Office add-in technologies that this book will not discuss. Application level Smart Tags add-ins and Smart Documents add-ins are not discussed because VSTO provides a much easier way of accessing Smart Tag and Smart Document functionality, albeit at the document or template level rather than at the application level. For more information on VSTO's support for Smart Tags and Smart Documents, see Chapter 15 and Chapter 16.

Creating an Outlook Add-in in VSTO

To create an Outlook add-in project in VSTO, choose Project... from the New menu of the File menu in Visual Studio. Select the Visual C# node from the list of project types and select the Office node under the Visual C# node. The Outlook Add-in project appears in the list of templates. Type a name for your new Outlook add-in project and pick a location for the project. Then press the OK button.

Figure 5

Figure 2-5: Creating a new Outlook add-in project.

VSTO creates a project with references to the Outlook 2003 PIA, the core Office PIA, and other needed references as shown in Figure 2-6. VSTO also adds a project item to the project called ThisApplication.cs. This project item contains a C# class that you will add to when implementing your Outlook add-in.

Figure 6

Figure 2-6: The Outlook add-in project in Solution Explorer.

If you double click on the ThisApplication.cs project item, you will see the code shown in Listing 2-4. There is a simple Startup and Shutdown event handler where you can write code that executes on the startup and shutdown of the add-in. The ThisApplication class derives from an aggregate of the Outlook Application object. This allows you to access properties and methods of the Outlook Application object by writing code like this.Inspectors.Count in the ThisApplication class.

Listing 2-4: The initial code in the ThisApplication class in an Outlook add-in project.

using System;
using System.Windows.Forms;
using Microsoft.VisualStudio.Tools.Applications.Runtime;
using Outlook = Microsoft.Office.Interop.Outlook;

namespace OutlookAddin1
{
 public partial class ThisApplication
 {
  private void ThisApplication_Startup(object sender, System.EventArgs e)
  {
  }

  private void ThisApplication_Shutdown(object sender, System.EventArgs e)
  {
  }

  #region VSTO Designer generated code
  private void InternalStartup()
  {
   this.Startup += new System.EventHandler(ThisApplication_Startup);
   this.Shutdown += new System.EventHandler(ThisApplication_Shutdown);
  }
  #endregion
 }
}

Looking at Listing 2-4 you may wonder about the use of "partial" in the class definition. VSTO uses partial classes which are a new feature of .NET that allows you to define part of a class in one file and another part of a class in a second file and then compile them together as one class. VSTO uses this feature to hide some additional generated code associated with the ThisApplication class from you to reduce the complexity of the class where you write your code. The final ThisApplication class will be compiled from the partial class in Listing 2-4 and additional code in a partial class generated by VSTO that is hidden from you.

We are going to add to the code in Listing 2-4 to create an add-in to that will solve an annoying problem—people replying inadvertently to an e-mail sent out to a mailing alias that contains a large number of people. Unless you have "Vice President" in your title, you probably do not want to be sending e-mail to more than, say, 25 people at any given time. We are going to create an add-in that will warn you if you do this and give you the "This is a potentially career limiting move. Are you sure you want to send this e-mail to 25,000 people?" message.

Outlook's Application object has an ItemSend event that fires whenever a user sends an email. We will add additional code to the Startup method of the ThisApplication class to hookup an event handler for the ItemSend event as shown in Listing 2-5. Because the ThisApplication class derives from an aggregate of Outlook's Application object, we can write the code "this.ItemSend" because ItemSend is an event raised by the ThisApplication base class. The ItemSend event handler takes an object parameter called Item which is the Outlook item being sent. Because Item could be any of a number of things such as a meeting request or an e-mail message, Item is passed as an object instead of as a specific type. The ItemSend event handler also has a bool parameter passed by reference called Cancel that can be set to true to prevent the Outlook item from being sent.

In our ItemSend event handler we need to check to see if the Item parameter which is passed as an object is actually an e-mail. The easiest way to achieve this is to use the as keyword to try to cast the Item parameter to an Outlook.MailItem. If the cast succeeds, the resulting value will be non-null and we will know that the item being sent is an Outlook.MailItem and therefore an e-mail message. We can then iterate through the Recipients collection on the MailItem object and check to see if we are sending to any recipient lists that include more than 25 people. Each Recipient object in the Recipients collection has an AddressEntry property that returns an AddressEntry object. The AddressEntry object has a Members property that returns a collection that we can check the count of. If we find the count to be more than 25, we will show a dialog and ask the user if they really want to send the mail. If the user clicks the No button, we will set the Cancel parameter of the ItemSend event to true to cancel the sending of career limiting e-mail.

Listing 2-5: A ThisApplication Class in an Outlook add-in project that handles the ItemSend event and checks for more than 25 recipients.

using System;
using System.Windows.Forms;
using Microsoft.VisualStudio.Tools.Applications.Runtime;
using Outlook = Microsoft.Office.Interop.Outlook;

namespace OutlookAddin1
{
 public partial class ThisApplication
 {
  private void ThisApplication_Startup(object sender, System.EventArgs e)
  {
   this.ItemSend += new Outlook.ApplicationEvents_11_ItemSendEventHandler(ThisApplication_ItemSend);
  }

  void ThisApplication_ItemSend(object Item, ref bool Cancel)
  {
   Outlook.MailItem myItem = Item as Outlook.MailItem;

   if (myItem != null)
   {
    foreach (Outlook.Recipient recip in myItem.Recipients)
    {
     if (recip.AddressEntry.Members.Count > 25)
     {
      // Ask the user if they really want to send this email
      string message = "Are you sure that you want to send mail to " +
       recip.AddressEntry.Name + " " + " which includes " +
       recip.AddressEntry.Members.Count + " people?";

      string caption = "More than 25 recipients";
      MessageBoxButtons buttons = MessageBoxButtons.YesNo;
      DialogResult result;

      result = MessageBox.Show(message, caption, buttons);

      if (result == DialogResult.No)
      {
       Cancel = true;
       break;
      }
     }
    }
   }
  }

  private void ThisApplication_Shutdown(object sender, System.EventArgs e)
  {
  }

  #region VSTO Designer generated code
  private void InternalStartup()
  {
   this.Startup += new System.EventHandler(ThisApplication_Startup);
   this.Shutdown += new System.EventHandler(ThisApplication_Shutdown);
  }
  #endregion
 }
}

When you run the project with the code shown in Listing 2-4, Outlook launches and the add-in loads. Try sending a mail to an alias that includes more than 25 people—you might want to go offline first in case you mistyped the code. If all works right, the add-in will display a dialog box warning you that you are sending an e-mail to more than 25 people and you will be able to cancel the send of the e-mail. Exit Outlook to end your debugging session.

VSTO Outlook add-ins are discussed in more detail in chapter 23. The Outlook object model is discussed in Chapters 9 through 11.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020