_FormRegionStartup.GetFormRegionIcon(String, Int32, OlFormRegionIcon) Método
Definición
Importante
Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.
Obtiene una imagen de icono que se mostrará para un tipo particular de icono para el área del formulario.
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 ObjectParámetros
- FormRegionName
- String
El nombre del área del formulario que se usa cuando se registra dicha área en el Registro de Windows.
- LCID
- Int32
El identificador de configuración regional que identifica el idioma que Outlook está usando actualmente. Este valor se usa para obtener las cadenas de localización que corresponden a este idioma para el área del formulario.
- Icon
- OlFormRegionIcon
Una constante que identifica el tipo de icono.
Devoluciones
Objeto que es una matriz de bytes que representa los bytes originales del archivo de imagen o un objeto IPictureDisp.
Comentarios
Este método está destinado a su implementación por parte de un complemento y para que Outlook lo llame. Como parte de la FormRegionStartup interfaz, este método y el método proporcionan un mecanismo a través del GetFormRegionManifest(String, Int32) cual un complemento puede registrar un área de formulario y proporcionar a Outlook el manifiesto XML y los iconos del área de formulario.
Si desea proporcionar iconos para un área de formulario con un complemento, especifique el ProgID del complemento al registrar el área de formulario en el registro de Windows. Para obtener más información sobre el registro de un área de formulario, vea Especificar regiones de formulario en el Registro de WindowsGetFormRegionManifest y los métodos GetFormRegionIcon de la interfaz FormRegionStartup .
En el manifiesto XML para el área del formulario, bajo el elemento icons, especifique el valor addin para cada uno de los elementos secundarios donde quiera usar un icono personalizado. Implemente GetFormRegionIcon de modo que cuando Outlook pase ese tipo de icono como argumento para Icon, GetFormRegionIcon devuelve la imagen del icono personalizado. Si desea que Outlook muestre el icono predeterminado, implemente GetFormRegionIcon para que devuelva Nothing (una referencia nula (Nothing en Visual Basic) en C#) para ese tipo de icono. GetFormRegionIcon también debe devolver Nothing (una referencia nula (Nothing en Visual Basic) en C#) cuando Icon es olFormRegionIconDefault.
Cuando se inicia Outlook, lee la lista de áreas de formulario en el registro de Windows y almacena en caché los datos asociados con las áreas de formulario. Si un área de formulario se ha registrado con un ProgID, Outlook recurrirá al complemento correspondiente llamando a su implementación de GetFormRegionIcon para cualquier icono del manifiesto XML que tenga addin como valor de un elemento secundario del elemento icons. Tenga en cuenta que si no especifica ningún ProgID en el registro de Windows, Outlook no llamará a los métodos GetFormRegionManifest y GetFormRegionIcon.