_FormRegionStartup.GetFormRegionIcon(String, Int32, OlFormRegionIcon) メソッド

定義

名前空間:

Microsoft.Office.Interop.Outlook

アセンブリ:

Microsoft.Office.Interop.Outlook.dll

フォーム領域の特定の種類のアイコンに対して表示されるアイコン イメージを取得します。

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

アイコンの種類を識別する定数を指定します。

戻り値

Object

イメージ ファイルの元のバイトを表すバイト配列または IPictureDisp オブジェクトである Object。

注釈

このメソッドは、アドインによる実装を目的としており、Outlook によって呼び出されます。 インターフェイスの FormRegionStartup 一部として、このメソッドと GetFormRegionManifest(String, Int32) メソッドは、アドインがフォーム領域を登録し、Outlook に XML マニフェストとフォーム領域のアイコンを提供するメカニズムを提供します。

フォーム領域のアイコンを提供するアドインの場合は、Windows レジストリでフォーム領域を登録するときにアドインの ProgID を指定します。 フォーム領域の登録の詳細については、「Windows レジストリ GetFormRegionManifestでのフォーム領域の指定」および FormRegionStartup インターフェイスの GetFormRegionIcon メソッドに関するページを参照してください。

フォーム領域の XML マニフェストで、icons 要素の下に、カスタム アイコンを使用する各子要素に対して値 addin を指定します。 GetFormRegionIcon を実装して、Outlook がその種類のアイコンを のIcon引数として渡すと、GetFormRegionIcon はカスタム アイコンの画像を返します。 Outlook で既定のアイコンを表示する場合は、その種類のアイコンの Nothing (Visual Basic では null 参照 (Visual Basic では Nothing)) を返すように GetFormRegionIcon を実装します。 GetFormRegionIcon は、 が olFormRegionIconDefault の場合Iconも Nothing (C#では null 参照 (Visual Basic では Nothing) を返す必要があります。

Outlook の起動時、Windows レジストリからフォーム領域の一覧を読み取りし、フォーム領域に関連付けられているデータをキャッシュします。 ProgID を使用してフォーム領域が登録されていると、Outlook は、addin を icons 要素の子要素の値として持つ XML マニフェストの、任意のアイコンの GetFormRegionIcon の実装を呼び出すことにより、対応するアドインを使用します。 呼び出さないことを場合は、Windows レジストリ内の ProgID を指定しないと、Outlook は、 GetFormRegionManifest メソッドと GetFormRegionIcon メソッドに注意してください。