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

Definição

Namespace:

Microsoft.Office.Interop.Outlook

Assembly:

Microsoft.Office.Interop.Outlook.dll

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

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

Parâmetros

FormRegionName

String

O nome da região do formulário usado ao registrar a região do formulário no Registro do Windows.

LCID

Int32

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

OlFormRegionIcon

A constant that identifies the type of icon.

Retornos

Object

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

Comentários

Esse método deve ser implementado por um suplemento e chamado pelo Outlook. Como parte da FormRegionStartup interface, esse método e o método fornecem um mecanismo por meio do GetFormRegionManifest(String, Int32) qual um suplemento pode registrar uma região de formulário e fornecer ao Outlook o manifesto XML e os ícones para a região do formulário.

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 região de formulário, consulte Especificando regiões de formulário no Registro do WindowsGetFormRegionManifest e os métodos GetFormRegionIcon da interface FormRegionStartup .

In the XML manifest for the form region, under the icons element, specify the value addin for each of the child elements where you would like to use a custom icon. Implemente GetFormRegionIcon de modo que quando o Outlook passar esse tipo de ícone como um argumento para Icon, GetFormRegionIcon retorna a imagem do ícone personalizado. Se você quiser que o Outlook exiba o ícone padrão, implemente GetFormRegionIcon de modo que ele retorne Nothing (uma referência nula (Nada no Visual Basic) em C#) para esse tipo de ícone. GetFormRegionIcon também deve retornar Nothing (uma referência nula (Nothing in Visual Basic) em C#) quando Icon é 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 tiver sido registrada com um ProgID, o Outlook recorrerá ao suplemento correspondente, chamando sua implementação de GetFormRegionIcon para qualquer ícone do manifesto XML que tenha addin como valor de um elemento filho do elemento icons. Observe que, se você não especificar qualquer ProgID no registro do Windows, o Outlook não serão chame os métodos GetFormRegionManifest e GetFormRegionIcon.