自定义 OUTLOOK 以便与企业应用程序集成

自定义Outlook以便与企业应用程序集成

摘要

在过去十年中，许多组织在客户关系管理(CRM)系统和业务流程(LOB)应用程序上投入了数十亿美元。虽然其中许多应用程序提供了重大的业务优势，但某些组织发现这些定制的系统并没有提供预期的投资回报。其中一个争论的原因是，专用企业系统、数据库和应用程序没有与信息工作者的工作流很好地集成在一起。

本文是系列文章的第三篇，该系列示范一个体系结构设计指南和相关的示例代码，以便将企业CRM和其他LOB应用程序与Microsoft Outlook集成在一起。本文中的指导来自Microsoft的Project Elixir，这是一个将重要客户数据集成到Outlook中的Microsoft内部IT计划。该设计使用Microsoft Visua l Studio2005Tools for Office(VSTO)、Microsoft SQL Server2005Express Edition(SQL Server Express)和Web服务。

该示例解决方案使用一组实用程序类来处理Outlook用户界面(UI)元素与托管代码外接程序的集成。本文讨论实用程序类的设计以及它们如何简化和推动Outlook外接程序的创建。有关整个解决方案体系结构的详细信息，请参阅使用Microsoft Outlook扩展企业应用程序：体系结构设计指南。有关如何下载示例代码的说明，请参阅Microsoft CRM Integration Sample for Outlook Source Setup下载页。有关本系列中其他文章的详细信息，请参阅本文结尾处的附加资源部分。

返回页首

简介

信息工作者将大部分时间花在使用基于桌面的Office应用程序上，来操作信息以及与同事共享信息。例如，信息工作者通常很熟悉Outlook，因为他们使用Outlook与同事和客户进行内部和外部沟通。因此，在设计解决方案以提供对企业CRM系统的访问时，您自然会选择为Outlook开发一个外接程序，该外接程序可以实现新的菜单、工具栏和数据格式，同时仍然为用户保持平稳、集成的体验。

过去，为Outlook创建外接程序是一项具有挑战性并且有时很复杂的任务。但是，随着VSTO2005的发布，开发人员现在具有一个Visual Studio模板，他们可以使用该模板加快使用托管代码的Outlook外接程序的创建。除了项目模板，VSTO还提供一个改进的运行库、一个健壮的外接程序加载器，以及对开发、调试和部署的更好支持。

使用VSTO创建的Outlook外接程序解决方案可以提供以下优势：

?.NETFramework编程优势。这些优势包括使用强类型的现代编程语言、自动内存管理、丰富的类库支持以及结构化异常处理。

?运行时隔离。运行时，专用的AddInLoader将VSTO外接程序加载到自己的应用程序域中。这提供了额外的安全性和隔离优势。（注：本文后面描述的Hosting Managed Controls in Outlook Folder Home Pages集成技术不提供该应用程

序域隔离。）

?安全性。管理员可以配置代码访问安全策略，以便为外接程序赋予所需的FullTrust权限集，因为它使用interop访问非托管Outlook应用程序。?部署。外接程序模板会创建一个安装项目，以部署外接程序和AddInLoader组件，并创建必需的注册表项。

随着VSTO2005的发布，为前端企业系统创建Outlook外接程序成为越来越实际的开发选择。本文描述一个示例外接程序解决方案，它可以通过Outlook用户界面访问虚拟CRM系统中保存的后台数据。该示例外接程序使用原始Outlook对象模型提供的扩展性在Outlook中提供自定义窗体和自定义处理。为此，该示例引入一组实用程序类，旨在简化常见的Outlook开发任务，并帮助处理自定义窗体与Outlook的集成。所开发的托管实用程序类可以重用，并且可能在其他Outlook外接程序解决方案中很有用。

有关VSTO中的Outlook外接程序开发支持优势的详细信息，请参阅Architecture of the Outlook Ad d-in Support in Visual Studio2005Tools for Office。

返回页首

体系结构

该示例外接程序解决方案的高级体系结构的主要组件如图1所示。这些组件包括Microsoft Office和Outlook主interop程序集(PIA)（外接程序代码通过它们与Outlook对象模型进行交互）、一组托管实用程序类，以及外接程序的应用程序代码。托管实用程序类被设计为帮助类，以简化示例CRM外接程序所需的某些常见的Outlook开发任务。

图 1.示例CRM外接程序解决方案概观（单击查看大图像）

本文讨论VSTO示例外接程序的设计、Outlook对象模型支持的Outlook自定义，以及关联的实用程序类。通过示例代码，本文展示了如何在本系列白皮书所描述的特定案例中使用这些实用程序类，以实现CRM

数据与Outlook的集成。

返回页首

VSTO Outlook模板

VSTO Outlook外接程序模板可以添加对多个程序集的引用并生成代码，以便Outlook对象模型可由Out look外接程序项目中的托管代码访问。使用VSTO Outlook外接程序模板创建新的外接程序项目时，该模板会创建以下内容：

?一个Outlook外接程序项目。

?一个名为ThisApplication的类。

?对Outlook对象和interop程序集的引用。

?一个Visual Studio部署项目。

该模板在ThisApplication类后面生成代码，以便为外接程序提供可靠的启动和关闭事件。对Outlook 对象的引用和互操作组件使外接程序中的托管代码能够引用Outlook对象模型，并在运行时提供托管代码与非托管COM Outlook对象模型之间的互操作。

注默认部署项目不包括设置安全策略以允许外接程序运行的代码。示例CRM外接程序项目包括一个自定义安装程序类（在Installer.cs文件中），该类设置了https://www.360docs.net/doc/9d4749829.html,ponentModel.RunInstaller属性，以表示Visual Studio自定义操作安装程序或安装程序工具(Installutil.exe)应该在安装解决方案时调用该类。

VSTO Outlook模板设置的引用

VSTO Outlook外接程序模板为使Outlook对象模型可用的几个组件添加了对新外接程序项目的引用。表1列出为此引用的组件和命名空间。

表1.为Outlook对象模型添加的组件和命名空间

组件命名空间描述

Office Core Microsoft.Office.Core主interop程序集。Office应

用程序所共有的对象。

VSTO Outlook Microsoft.Office.Tools.Outlook包含Application类。生成的

ThisApplication类派生自该

Application类。

Outlook interop Microsoft.Office.InterOp.Outlook COM Outlook对象模型的主

interop程序集。

Visual

Studio运

行库

Microsoft.VisualStudio.Tools提供运行时隔离和安全性。

在Outlook外接程序中编写的代码的主访问点，将通过由VSTO模板生成的ThisApplication类，并且这是VSTO Outlook组件的Application类的实现。

此外，模板还会生成对Office Core组件的引用。这提供对所有Office应用程序所共有的类的访问。例如，工具栏和菜单位于Office Core程序集中。

Outlook对象模型

对于编写Outlook宏样式代码的Microsoft Visual Basic for Applications(VBA)开发人员而言，他们应该对自定义外接程序代码可用的Outlook对象模型很熟悉。图2显示Outlook对象模型中的重要对象。

图 2.在Outlook对象模型中选择的对象（单击查看大图像）

Outlook对象模型的组织已将数据和UI分开。包括Session对象的分支描述数据，而包含Explorer 和Inspector对象的分支描述UI。

在Outlook UI中，文件夹显示在左侧的大纲列表中，Explorer主窗口显示所选文件夹的内容，而Insp ector会弹出以显示单项的详细信息。例如，在图3所示的Outlook中，选择了Contacts文件夹，并且Explorer主窗口显示联系人数据表格。通过双击“Howard Gonzalez”联系人项，用户在默认的联系人Inspector中弹出他的详细信息。

图 3.Outlook中的主UI区（单击查看大图像）

在代码中，您可以使用Application对象的ActiveExplorer和ActiveInspector方法访问当前的Exp lorer或Inspector对象。工具栏和菜单附加到Explorer和Inspector对象，如下所示。

private void ThisApplication_Startup(object sender,System.EventArgs e)

{

Outlook.Explorer explorer=this.ActiveExplorer();

Outlook.Inspectors inspector=this.ActiveInspector();

}

前面的代码表明可使用this关键字访问Outlook Application对象。这是可能的，因为ThisApplicat ion类派生自VSTO Outlook程序集中的Application类。（该类的完全限定名称是Microsoft.Office. Tools.Outlook.Application。）

在代码中，可定位到浏览器所显示的文件夹以及检查器所显示的项。图4显示它们在部分Outlook对象模型中的关系：

图 4.UI和数据对象之间的关系

使用Microsoft C#调用Office代码

Office Core中的COM对象和Outlook对象模型希望通过引用传递参数，并且Office Core中的对象允许可选参数。COM interop层可以帮助您将传值参数转换为引用。Visual https://www.360docs.net/doc/9d4749829.html,支持可选参数，但C#不支持。因此，在实用程序类中，您将发现提供了方法的所有参数，并且在未提供某个参数值时使用Type.Missing。例如，以下示例调用提供两个缺失参数。

menuBar.Controls.Add(

Office.MsoControlType.msoControlPopup,

Type.Missing,

Type.Missing,

helpMenuIndex,

true);

有关使用C#调用Office代码的详细信息，请参阅Programming Office Applications with Microsof t Visual C#白皮书。

返回页首

托管实用程序类

这些类的目标是简化常见的Outlook开发任务，并提高构建和维护Outlook托管代码外接程序的简单性和速度。这些类旨在补充和扩展原始Outlook对象模型所提供的基准Outlook扩展性。具体来说，这些类可以：

?为工具栏和菜单管理提供附加支持。

?为窗口和自定义项管理提供附加支持。

?提供通用的Outlook项类型，以允许对所有Outlook项类型提供的基准功能进行多态访问。

?允许应用程序数据与SQL Express本地数据存储进行同步。（本文不讨论该主题。有关详细信息，请参阅Synchronizing a Local Data Store with Microsoft Outlook）。

图5展示作为示例外接程序的一部分而创建的主要托管实用程序类。

图5主要托管实用程序类（单击查看大图像）

托管实用程序类包括：

?CustomItemManager。当一个Outlook项代替默认的Outlook检查器打开时，该类负责管理将窗体作为自定义检查器启动。它还管理将数据存储在数据库中的标准检查器（例如，Contact检查器）的Write事件处理程序。?ItemAdapter。它为不同的Outlook项类型（例如，Task、Contact和Email）提供一个通用的适配器类。它公开所有Outlook项类型共用的一组属性和方法，并启用Outlook项的一般处理。

?Folder。它具有处理Outlook文件夹的选择和创建的静态方法。

?FolderHomePage。它具有注册要用作自定义文件夹主页的Windows窗体控件的静态方法。

?CommandBarManager。它可以保留映射，以通过检查器窗口和资源管理器窗口允许工具栏和菜单的注册，并确保工具栏和菜单自动附加到所有资源管理器和检查器窗口。

?CommandBar。它是ToolBar和Menu类的基类。

?ToolBar。它表示能够附加到资源管理器和检查器窗口的工具栏。工具栏具有一个ToolBarControl对象集合。

?ToolBarControl。它是可以出现在工具栏上的控件的基类。具体实现是ToolBarButton、ToolBarComboBox和ToolBarTextBox。

?Menu。它表示能够附加到资源管理器和检查器窗口的菜单。菜单具有一个MenuItem对象集合。

?OutLookViewControl。它为ActiveX Outlook视图控件提供一个包装，因此它可以实例化以便在托管代码项目中使用。

在示例外接程序代码中使用实用程序类可以创建自定义Outlook用户界面，以提供对虚拟CRM后端系统数据的访问。示例外接程序用户界面的元素包括：

?Custom folders。它们充当CRM数据的容器。

?Custom toolbars and menus。它们提供对CRM操作的访问。

?Custom inspector windows。它们重写默认的Outlook检查器，以允许显示和操作其他CRM数据。

?Custom folder home pages。它们提供自定义CRM文件夹的概述和摘要信息。

以下部分详细描述了如何使用实用程序类在示例解决方案中创建每个用户界面元素。

返回页首

添加自定义文件夹

示例外接程序创建了一个新的CRM Today根文件夹，作为CRM应用程序在Outlook中的自定义的容器。图6显示在CRM Today文件夹中为每个CRM帐户添加了新文件夹，包括自定义的CRM Activities和CRM Opportunities项以及与该帐户关联的标准Contact项。

图 6.CRM Today根文件夹下的自定义CRM帐户文件夹

启动时，外接程序需要创建新文件夹，或者确认文件夹已经存在。这是使用实用程序类Folder的静态方法实现的。例如，在示例中使用以下代码添加新的CRM Today文件夹。

using Outlook=Microsoft.Office.Interop.Outlook;

using Utility=Microsoft.Sample.Outlook.Utility;

...

Outlook.MAPIFolder root=Utility.Folder.GetRootFolder(this.Session); Outlook.MAPIFolder crmFolder=Utility.Folder.CreateFolder(

root,Properties.Resources.CRMFold erName);

请注意，上述代码从资源字符串中获得新文件夹的名称，因此它可以本地化。您可以使用类似的代码为C RM帐户添加新文件夹，但在这种情况下，文件夹名称将来自CRM数据。

返回页首

添加自定义工具栏和菜单

除了自定义文件夹以外，示例外接程序还需要自定义菜单项和工具栏按钮来启动它的自定义进程和窗体。本部分将说明如何使用实用程序类将自定义工具栏和菜单项添加到Outlook中。

CommandBarManager类跟踪新的资源管理器和检查器窗口的创建，并确保添加正确的命令栏。尽管有多种类型的菜单和工具栏，但您实现它们的方法都是类似的。菜单和工具栏的类型包括：

?工具栏和按钮（或其他控件）。

?添加到现有Outlook菜单中的新菜单。

?弹出式菜单。

示例外接程序创建了一个具有几个按钮的命令栏，这些按钮允许用户将电子邮件项转换为CRM活动或CR M机会。为此，外接程序具有一个CommandBarManager类的对象，其私有范围在ThisApplication类中。该CommandBarManager对象允许注册菜单或工具栏。然后，它确保将注册后的工具栏和菜单添加到所有新的Outlook资源管理器和检查器窗口中，并确保正确处理它们的事件。

创建新的工具栏或菜单栏：

?创建新的菜单或工具栏对象。

?将控件（如菜单按钮）添加到工具栏或菜单栏。

?将事件处理程序添加到控件。

?使用CommandBarManager对象注册新的菜单或工具栏。

图7显示为示例外接程序创建的新自定义工具栏，以及位于标准Outlook Help菜单后面的新CRM Inte gration Sample菜单。

图7.在Help菜单后面插入的自定义菜单栏

示例中的以下代码添加了一个新工具栏和两个按钮，及其关联的事件处理程序。它还添加了一个事件，在Outlook资源管理器或检查器窗口中显示工具栏之前会激发该事件。

using Utility=Microsoft.Sample.Outlook.Utility;

...

private void CreateConvertToolbar()

{

Utility.Toolbar crmToolbar=new Utility.Toolbar("Contoso CRM Conve rt");

Utility.ToolbarButton btnCreateActivity=new Utility.ToolbarButton (

"Convert to CRM Activity"); Utility.ToolbarButton btnCreateOpportunity=new Utility.ToolbarBut ton(

"Convert to CRM Opportunity ");

btnCreateActivity.Click+=new

EventHandler(btnCreateActivity_Click); btnCreateOpportunity.Click+=new

EventHandler(btnCreateOpportunity_Click);

crmToolbar.Controls.Add(btnCreateActivity);

crmToolbar.Controls.Add(btnCreateOpportunity);

crmToolbar.BeforeShow+=new

EventHandler(

crmToolbar_BeforeShow); _commandbarManager.RegisterCommandBar(crmToolbar);

}

请注意，上述代码使用了一个名为_commandbarManager的私有CommandBarManager对象。此外，在该示例中为了清楚起见，工具栏按钮上的文本已经硬编码；在生产应用程序中，您应该将这些字符串添加到资源中，以便能够将它们本地化为不同的语言。

返回页首

添加自定义检查器窗口

示例外接程序实现了自定义检查器窗口，因此从数据库获得的CRM活动和CRM机会数据可以显示在Out look UI中。自定义窗口作为托管Windows窗体类创建，并且通过实用程序类CustomItemManager在O utlook中注册为自定义检查器。这可确保每当在Outlook中选择某项以进行检查时，都会使用自定义检查器。例如，图8显示自定义的Opportunity检查器窗口，该窗口在用户双击特定机会项时弹出。

图8.自定义的Opportunity检查器窗口（单击查看大图像）

CustomItemManager类跟踪新检查器窗口的创建，并在适当的时候替换自定义窗口。示例外接程序代码包含一个CustomItemManager类的对象，其私有范围在名为_itemManager的ThisApplication类中。创建Opportunities文件夹时，用于提供自定义机会检查器的Windows窗体在_itemManager中注册。例如：

using Outlook=Microsoft.Office.Interop.Outlook;

using Utility=Microsoft.Sample.Outlook.Utility;

...

Outlook.MAPIFolder opportunityFolder=Utility.Folder.CreateFolder( accountFolder,

Properties.Resources.OpportunitiesFolderName,

Outlook.OlDefaultFolders.olFolderInbox);

_itemManager.RegisterCustomForm(opportunityFolder,

typeof(ItemForms.Opportun ityForm));

这意味着，文件夹包含的项类型的默认检查器将由使用OpportunityForm类的Windows窗体替换。在C ustomItemManager类中，窗体创建的处理方式是，使用反射查找窗体的构造函数，并检查是否可以将项目引用传递给该函数。

void CreateCustomForm(ItemAdapter adapter,Type formType)

{

System.Reflection.ConstructorInfo ci=

formType.GetConstructor(new Type[]{typeof(ItemAdapter) });

if(ci==null)

{

throw new ApplicationException(

"Form types must have a constructor that takes an ItemAdapter parameter");

}

System.Windows.Forms.Form form=(System.Windows.Forms.Form)

ci.Invoke(new object[] {adapter});

form.Show();

}

将Windows窗体创建为自定义检查器

如前面部分中所述，要使Windows窗体适于注册到CustomItemManager对象中，它必须有一个使用Ite mAdapter对象作为参数的构造函数。在实例化窗体以检查现有项时，这允许CustomItemManager向自定义窗体传递一个对要检查的项的引用。

下面显示OpportunityForm类的示例代码。请注意，该代码提供了构造函数的两个重载：第一个重载没有参数，并且允许创建窗体以添加新的机会项；第二个重载使用ItemAdapter引用，以允许编辑现有的机会项。

using Utility=Microsoft.Sample.Outlook.Utility;

...

namespace Microsoft.Sample.ContosoCRM.ItemForms

{

internal sealed partial class OpportunityForm:Form

{

Utility.ItemAdapter_opportunity;

public OpportunityForm()

{

InitializeComponent();

}

public OpportunityForm(Utility.ItemAdapter item)

{

InitializeComponent();

if(item.Class!=Outlook.OlObjectClass.olPost)

{

throw new ApplicationException(

"ActivityForm can only be initialized with outlook post i tems");

}

_opportunity=item;

}

...

}

}

ItemAdapter实用程序类有多个方法，可以将对象作为其中一个Outlook项类型返回。这允许自定义Wi ndows窗体中的代码访问Outlook项属性。例如，自定义的机会窗体使用Outlook AppointmentItem类显示数据。

using Outlook=Microsoft.Office.Interop.Outlook;

...

Outlook.AppointmentItem appt=item.GetAsAppointment();

this.textBoxComments.Text=appt.Body;

this.textBoxName.Text=appt.Subject;

随后，在最终使用ItemAdapter实用程序类的Save方法将更改保存回项时，该自定义窗体可以提供自定义外接程序所需的处理。

自定义Write处理程序

CustomItemManager还管理将数据存储在数据库中的标准检查器的Write事件处理程序。例如，示例CR M外接程序使用默认的Outlook联系人检查器来显示与CRM帐户关联的联系人。在创建联系人文件夹时，可以将自定义的写入事件注册到CustomItemManager对象中，如下所示。

itemManager.RegisterWriteHandler(

contactFolder,new CancelEventHandler(OnContact Write));

用户保存联系人数据时，CustomItemManager会激发自定义的写入事件。在示例CRM外接程序中，这允许检索与联系人关联的其他数据，以存储在本地数据库中。OnContactWrite事件使用标准的sender和ev ent参数格式，其中，sender对象使用ItemAdapter表示所保存的Outlook联系人项。例如，这允许您使用与以下类似的代码来检索与联系人项关联的帐户的标识符。

using Outlook=Microsoft.Office.Interop.Outlook;

using Utility=Microsoft.Sample.Outlook.Utility;

...

void OnContactWrite(object sender,CancelEventArgs e)

{

Utility.ItemAdapter item=(Utility.ItemAdapter)sender;

//Get the associated account ID form the parent folder's OutlookID Outlook.MAPIFolder folder=(Outlook.MAPIFolder)item.Parent; Outlook.MAPIFolder accountFolder=(Outlook.MAPIFolder)folder.Paren t;

Guid AccountID=(Guid)accountsAdapter.GetLocalID(accountFolder.Ent ryID);

...

}

返回页首

在Outlook文件夹主页中宿主托管控件

设计Outlook的UI时，您可能会面对的一个问题是，如何使自定义窗体显示在Outlook应用程序的主窗口中，以及随后如何与Outlook的其他元素交互。在Outlook外接程序中创建非模式的自定义Windo ws窗体相对简单，但窗体会显示在Outlook主窗口的外面，从而使核心Outlook UI不易识别，并妨碍了可能需要的紧密集成。

实用程序类FolderHomePage使用能够自定义Outlook文件夹的技术，以便在其主页窗口中显示HTML

文件。随后，它可以使用该HTML文件宿主托管控件。FolderHomePage类将一个小脚本添加到HTML文件中，以便托管控件可以引用Outlook应用程序并与之交互。

图9显示在Folder List中选择的示例CRM外接程序文件夹CRM Today。文件夹主页显示一个HTML

文件，并且主页宿主了一个托管控件以提供自定义UI。HTML文件的视图称为文件夹的Web视图。

图9.CRM Today文件夹Web视图中的托管控件（单击查看大图像）

注将多个外接程序加载到一个Outlook实例中时，本部分所描述的方法可能会出现问题，因为该方法要求将解决方案的组件加载到默认应用程序域中。另一个也需要将组件加载到默认应用程序域的外接程序可能会与您的外接程序冲突，并导致Outlook不稳定。为此，不建议您针对在Outlook中安装了多个托管外接程序的桌面使用该方法。

体系结构

图10显示在使用文件夹Web视图宿主托管控件时工作的主要组件。文件夹Web视图能够从HTML文件显示Web页，而Web页能够使用