Método FormRegionStartup.GetFormRegionIcon (Outlook)

Obtains an icon image that will be displayed for a particular type of icon for the form region.

Sintaxe

expression. GetFormRegionIcon( _FormRegionName_ , _LCID_ , _Icon_ )

Expressão Uma variável que representa um objeto "FormRegionStartup".

Parâmetros

Nome	Obrigatório/Opcional	Tipo de dados	Descrição
Formregionname	Obrigatório	String	O nome da região do formulário usado ao registrar a região do formulário no Registro do Windows.
LCID	Obrigatório	Long	A ID do local que identifica o idioma usado pelo Outlook no momento. Esse valor é usado para obter as cadeias de caracteres de localização correspondentes a esse idioma a partir da região do formulário.
Icon	Obrigatório	OlFormRegionIcon	A constant that identifies the type of icon.

Valor de retorno

Um Variant que é uma matriz de bytes que representa os bytes originais do arquivo de imagem ou um objeto IPictureDisp.

Comentários

This method is intended to be implemented by an add-in and called by Outlook. As part of the FormRegionStartup interface, this method and the GetFormRegionManifest method provide a mechanism through which an add-in can register a form region and provide Outlook with the XML manifest and the icons for the form region.

Se você gostaria de um suplemento para fornecer ícones para uma área de formulário, especifique o ProgID do suplemento ao registrar a região de formulário no registro do Windows. Para obter mais informações sobre como registrar uma área de formulário, consulte Especificando áreas de formulário no registro do Windows. O suplemento deve implementar os GetFormRegionManifest e os métodos de GetFormRegionIcon da interface FormRegionStartup.

No manifesto XML para a área de formulário, sob o elemento de ícones, especifique o valor addin para cada um dos elementos filhos onde você gostaria de usar um ícone personalizado. Implemente GetFormRegionIcon de modo que, quando o Outlook passa esse tipo de ícone como um argumento para Ícone , GetFormRegionIcon retorna a imagem do ícone personalizado. If you want Outlook to display the default icon, implement GetFormRegionIcon such that it returns null (Nothing in Visual Basic) for that type of icon. GetFormRegionIcon também deve retornar nulo (Nada no Visual Basic) quando Icon for olFormRegionIconDefault.

Quando o Outlook for iniciado, ele lê a lista de regiões de formulário do registro do Windows e o armazena em cache os dados associados com as regiões de formulário. Se uma área de formulário foi registrada com um ProgID, Outlook será recorrer ao suplemento correspondente chamando sua implementação do GetFormRegionIcon para qualquer ícone no manifesto XML que tenha addin como o valor de um elemento filho do elemento de ícones. Observe que, se você não especificar nenhum ProgID no registro do Windows, o Outlook não chamará os métodos GetFormRegionManifest e GetFormRegionIcon .

Confira também

Interface FormRegionStartup

Suporte e comentários

Tem dúvidas ou quer enviar comentários sobre o VBA para Office ou sobre esta documentação? Confira Suporte e comentários sobre o VBA para Office a fim de obter orientação sobre as maneiras pelas quais você pode receber suporte e fornecer comentários.