_FormRegionStartup.GetFormRegionManifest(String, Int32) 方法

定义

获取窗体区域的 XML 清单。

public:
 System::Object ^ GetFormRegionManifest(System::String ^ FormRegionName, int LCID);
public object GetFormRegionManifest (string FormRegionName, int LCID);
Public Function GetFormRegionManifest (FormRegionName As String, LCID As Integer) As Object

参数

FormRegionName
String

在 Windows 注册表中注册窗体区域时使用的窗体区域的名称。

LCID
Int32

标识 Outlook 当前使用的语言的区域设置 ID。 此值用于获取与窗体区域的此语言相对应的本地化字符串。

返回

一个 对象 ,表示窗体区域的 XML 清单。 该 XML 字符串包含窗体区域,如显示名称 (按照指定的标题元素)、 任何相关的布局文件或外接程序中,任何受支持的用户操作和任何本地化字符串的特征。 XML 必须按照窗体区域 XML 架构。 有关窗体区域 XML 架构的详细信息,请参阅 MSDN 库中的 Microsoft Outlook 2010 XML 架构参考

注解

此方法应由加载项实现并由 Outlook 调用。 作为 接口的 FormRegionStartup 一部分,此方法和 GetFormRegionIcon(String, Int32, OlFormRegionIcon) 方法提供了一种机制,加载项可以通过该机制注册窗体区域,并为 Outlook 提供 XML 清单和窗体区域的图标。

如果您希望使用加载项来提供某个窗体区域的 XML 清单,请在 Windows 注册表中注册该窗体区域时指定相应加载项的 ProgID。 有关注册窗体区域的详细信息,请参阅 FormRegionStartup 接口的 Windows 注册表GetFormRegionManifest 方法中的指定窗体区域。 请注意,如果您未在 Windows 注册表中指定任何 ProgID,则 Outlook 将不会调用此方法。

依靠外接程序提供一个窗体区域的 XML 清单也意味着您允许外接程序为该窗体区域提供的任何图标。 外接程序必须实现 FormRegionStartup 接口 GetFormRegionIcon 。 Outlook 将调用 GetFormRegionIcon 来获取任何外接程序中指定的图标的窗体区域。 有关使用外接程序指定图标的详细信息,请参阅 如何:使用外接程序指定窗体区域的图标

当 Outlook 启动时,它会从 Windows 注册表中读取列表中的窗体区域并缓存的数据。 根据这些数据,如果 Outlook 注意外, 接程序已指定要为窗体区域提供的 XML 清单,Outlook 将使用 ProgID中的缓存的数据和调用 GetFormRegionManifest 方法实现由该外接程序获取它需要显示窗体区域 XML 提供。 如果 XML 清单无效并且不符合窗体区域 XML 架构,Outlook 将不能加载窗体区域。 此外,如果您在 Windows 注册表中未指定任何 ProgID ,Outlook 将调用 GetFormRegionManifestGetFormRegionIcon 的方法。

当加载项提供 XML 清单时,Outlook 会忽略以下元素:

适用于