_FormRegionStartup.GetFormRegionIcon(String, Int32, OlFormRegionIcon) 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
获取一个将为窗体区域的特定类型图标显示的图标图像。
public:
System::Object ^ GetFormRegionIcon(System::String ^ FormRegionName, int LCID, Microsoft::Office::Interop::Outlook::OlFormRegionIcon Icon);
public object GetFormRegionIcon (string FormRegionName, int LCID, Microsoft.Office.Interop.Outlook.OlFormRegionIcon Icon);
Public Function GetFormRegionIcon (FormRegionName As String, LCID As Integer, Icon As OlFormRegionIcon) As Object
参数
- FormRegionName
- String
在 Windows 注册表中注册窗体区域时使用的窗体区域的名称。
- LCID
- Int32
标识 Outlook 当前使用的语言的区域设置 ID。 此值用于获取与窗体区域的此语言相对应的本地化字符串。
- Icon
- OlFormRegionIcon
一个标识图标类型的常量。
返回
一个 对象,它是表示图像文件的原始字节的字节数组或 IPictureDisp 对象。
注解
此方法应由加载项实现并由 Outlook 调用。 作为接口的 FormRegionStartup 一部分,此方法和 GetFormRegionManifest(String, Int32) 方法提供了一种机制,加载项可以通过该机制注册窗体区域,并为 Outlook 提供 XML 清单和窗体区域的图标。
如果您将外接程序来为窗体区域提供的图标,请指定的外接程序的 ProgID,当您在 Windows 注册表中注册窗体区域。 有关注册窗体区域的详细信息,请参阅在 Windows 注册表 GetFormRegionManifest中指定窗体区域和 FormRegionStartup 接口的 GetFormRegionIcon 方法。
在窗体区域的 XML 清单的 icons 元素下,为要使用自定义图标的每个子元素指定 addin 值。 实现 GetFormRegionIcon ,以便在 Outlook 传递该类型的图标作为 的参数 Icon
时, GetFormRegionIcon 返回自定义图标的图像。 如果希望 Outlook 显示默认图标,请实现 GetFormRegionIcon ,以便它返回 Nothing (null 引用 (Visual Basic) 中为该图标类型返回 Nothing ) 。 当 为 olFormRegionIconDefault 时Icon
,GetFormRegionIcon 还应返回 Nothing (null 引用 (Visual Basic) ) 中的 Nothing。
当 Outlook 启动时,它会从 Windows 注册表中读取列表中的窗体区域并缓存的窗体区域相关联的数据。 如果某个窗体区域已注册到 ProgID,Outlook 将通过调用其 GetFormRegionIcon 实现来使用相应的外接程序,该图标在 XML 清单中将 addin 作为 icon 元素的子元素的值。 请注意,是否您在 Windows 注册表中未指定任何 ProgID,Outlook 将不会调用的 GetFormRegionManifest 和 GetFormRegionIcon 方法。