Freigeben über


_FormRegionStartup.GetFormRegionIcon(String, Int32, OlFormRegionIcon) Methode

Definition

Ruft eine Symbolgrafik ab, die für einen bestimmten Symboltyp eines Formularbereichs angezeigt wird.

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

Parameter

FormRegionName
String

Der Name des Formularbereichs, der bei der Registrierung des Formularbereichs in der Windows-Registrierung verwendet wird.

LCID
Int32

Die Gebietsschema-ID, die die aktuell von Outlook verwendete Sprache identifiziert. Dieser Wert wird verwendet, um die Lokalisierungszeichenfolgen für den Formularbereich abzurufen, die dieser Sprache entsprechen.

Icon
OlFormRegionIcon

Eine Konstante, die den Symboltyp angibt.

Gibt zurück

Ein Objekt , das entweder ein Bytearray ist, das die ursprünglichen Bytes der Bilddatei darstellt, oder ein IPictureDisp-Objekt .

Hinweise

Diese Methode sollte durch ein Add-In implementiert und von Outlook aufgerufen werden. Als Teil der FormRegionStartup -Schnittstelle stellen diese Methode und die GetFormRegionManifest(String, Int32) -Methode einen Mechanismus bereit, mit dem ein Add-In einen Formularbereich registrieren und Outlook das XML-Manifest und die Symbole für den Formularbereich bereitstellen kann.

Wenn Sie ein Add-in Symbole für einen Formularbereich bereitstellen möchten, geben Sie die ProgID des Add-Ins, wenn Sie den Formularbereich in der Windows-Registrierung registrieren. Weitere Informationen zum Registrieren eines Formularbereichs finden Sie unter Angeben von Formularbereichen in der Windows-RegistrierungGetFormRegionManifest und den GetFormRegionIcon-Methoden der FormRegionStartup-Schnittstelle .

Geben Sie im XML-Manifest für den Formularbereich unter dem icons-Element den Wert addin für jedes der untergeordneten Elemente an, für die ein benutzerdefiniertes Symbol verwendet werden soll. Implementieren Sie GetFormRegionIcon so, dass GetFormRegionIcon das Bild des benutzerdefinierten Symbols zurückgibt, wenn Outlook diesen Symboltyp als Argument für Iconübergibt. Wenn Outlook das Standardsymbol anzeigen soll, implementieren Sie GetFormRegionIcon so, dass Nothing (ein NULL-Verweis (Nothing in Visual Basic) in C#) für diesen Symboltyp zurückgegeben wird. GetFormRegionIcon sollte auch Nothing (ein NULL-Verweis (Nothing in Visual Basic) in C#) zurückgeben, wenn IconolFormRegionIconDefault ist.

Wenn Outlook startet, wird die Liste der Formularbereiche in der Windows-Registrierung gelesen und die den Formularbereichen zugeordneten Daten zwischengespeichert. Wenn ein Formularbereich mit einer ProgID registriert wurde, greift Outlook auf das entsprechende Add-In zurück, indem die Implementierung von GetFormRegionIcon für jedes Symbol im XML-Manifest aufgerufen wird, das addin als Wert eines untergeordneten Elements des Symbols-Elements aufweist. Beachten Sie, dass Outlook die Methoden GetFormRegionManifest und GetFormRegionIcon nicht aufruft, wenn Sie in der Windows-Registrierung keine ProgID angeben.

Gilt für: