Méthode FormRegionStartup.GetFormRegionIcon (Outlook)
Obtient une image d’icône qui s’affichera pour un type particulier d’icône de la zone de formulaire.
Syntaxe
expression. GetFormRegionIcon( _FormRegionName_ , _LCID_ , _Icon_ )
Expression Variable qui représente un objet « FormRegionStartup ».
Parameters
| Nom | Requis/Facultatif | Type de données | Description |
|---|---|---|---|
| FormRegionName | Requis | 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 | Obligatoire | Long | 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 | Requis | OlFormRegionIcon | Constante qui identifie le type d’icône. |
Valeur renvoyée
Valeur de type Variante qui est soit un tableau d’octets qui représente les octets d’origine du fichier image, soit 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 méthode GetFormRegionManifest 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, voir Spécification de régions de formulaire dans le Registre Windows. Le complément doit implémenter les méthodes GetFormRegionManifest et GetFormRegionIcon de l’interface FormRegionStartup .
Dans le manifeste XML de la zone de formulaire, sous l’élément icônes , spécifiez la valeur addin de chacun des éléments enfants dans lesquels 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 voulez qu’Outlook affiche l’icône par défaut, implémentez la méthode GetFormRegionIcon pour qu’elle renvoie la valeur null (Nothing dans Visual Basic) pour ce type d’icône. GetFormRegionIcon doit également retourner null (Nothing en Visual Basic) 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 dans le 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 .
Voir aussi
Assistance et commentaires
Avez-vous des questions ou des commentaires sur Office VBA ou sur cette documentation ? Consultez la rubrique concernant l’assistance pour Office VBA et l’envoi de commentaires afin d’obtenir des instructions pour recevoir une assistance et envoyer vos commentaires.