_FormRegionStartup.GetFormRegionIcon(String, Int32, OlFormRegionIcon) Méthode

Définition

Espace de noms:

Microsoft.Office.Interop.Outlook

Assembly:

Microsoft.Office.Interop.Outlook.dll

Obtient une image d’icône qui s’affichera pour un type particulier d’icône de la zone de formulaire.

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

Paramètres

FormRegionName

String

Nom de la zone de formulaire qui correspond au nom utilisé lors de l’inscription de la zone de formulaire dans le Registre Windows.

LCID

Int32

ID de paramètres régionaux qui identifie la langue utilisée par Outlook. Cette valeur permet d’obtenir les chaînes de traduction correspondant à cette langue pour la zone de formulaire.

Icon

OlFormRegionIcon

Constante qui identifie le type d’icône.

Retours

Object

Objet qui est un tableau d’octets qui représente les octets d’origine du fichier image ou un objet IPictureDisp.

Remarques

Cette méthode est destinée à être implémentée par un complément et appelée par Outlook. Dans le cadre de l’interface FormRegionStartup , cette méthode et la GetFormRegionManifest(String, Int32) méthode fournissent un mécanisme par lequel un complément peut inscrire une zone de formulaire et fournir à Outlook le manifeste XML et les icônes de la zone de formulaire.

Si vous voulez qu’un complément fournisse des icônes pour une zone de formulaire, spécifiez l’identificateur de programme (ProgID) du complément au moment d’inscrire la zone de formulaire dans le Registre Windows. Pour plus d’informations sur l’inscription d’une zone de formulaire, consultez Spécification de zones de formulaire dans le registre WindowsGetFormRegionManifest et les méthodes GetFormRegionIcon de l’interface FormRegionStartup .

Dans le manifeste XML de la zone de formulaire, sous l’élément icons, spécifiez la valeur addin pour chaque élément enfant où vous souhaitez utiliser une icône personnalisée. Implémentez GetFormRegionIcon de sorte que quand Outlook transmet ce type d’icône comme argument pour Icon, GetFormRegionIcon retourne l’image de l’icône personnalisée. Si vous souhaitez qu’Outlook affiche l’icône par défaut, implémentez GetFormRegionIcon de sorte qu’il retourne Nothing (référence null (Nothing en Visual Basic) en C#) pour ce type d’icône. GetFormRegionIcon doit également renvoyerNothing (référence null (Nothing en Visual Basic) en C#) quand Icon a la valeur olFormRegionIconDefault.

Au moment de démarrer, Outlook lit la liste des zones de formulaire dans le Registre Windows et met en cache les données associées aux zones de formulaire. Si une zone de formulaire a été inscrite avec un ProgID, Outlook a recours au complément correspondant en appelant son implémentation de GetFormRegionIcon pour toute icône du manifeste XML qui a addin comme valeur d’un élément enfant de l’élément icons. Notez que si vous ne spécifiez aucun ProgID dans le Registre Windows, Outlook n’appellera pas les méthodes GetFormRegionManifest et GetFormRegionIcon .