Método FormRegionStartup.GetFormRegionManifest (Outlook)

Obtém o manifesto XML de uma região de formulário.

Sintaxe

expression. GetFormRegionManifest( _FormRegionName_ , _LCID_ )

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.

Valor de retorno

Um Variant que representa o manifesto XML para uma região do formulário. Esta cadeia de caracteres XML inclui características da região do formulário como o nome de exibição (como especificado pelo elemento title), qualquer arquivo de layout associado ou suplemento, quaisquer ações do usuário com suporte e qualquer cadeia de caracteres de localização. O XML deve seguir o esquema XML de região de formulário. Para obter mais informações sobre o esquema XML da região do formulário, consulte a Referência de Esquema XML Microsoft Outlook 2010 no Biblioteca MSDN.

Comentários

Esse método deve ser implementado por um suplemento e chamado pelo Outlook. Como parte da interface FormRegionStartup, esse método e o método GetFormRegionIcon oferecem um mecanismo pelo qual um suplemento pode registrar uma região do 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 o manifesto XML para uma área de formulário, especifique o ProgID do add-in ao registrar a região de formulário no registro do Windows. For more information on registering a form region, see Specifying Form Regions in the Windows Registry. O suplemento deve implementar o método GetFormRegionManifest da interface FormRegionStartup. Observe que, se você não especificar nenhum ProgID no registro do Windows, o Outlook não chamará esse método.

O uso de um suplemento para fornecer que o manifesto XML para uma região do formulário também significa que você está permitindo que o suplemento fornecer nenhum ícone para a área de formulário. O suplemento também deve implementar o GetFormRegionIcon da interface FormRegionStartup. Outlook chamará GetFormRegionIcon para obter qualquer suplemento especificados ícones para a região do formulário. Para obter mais informações sobre o uso de um suplemento para especificar ícones, consulte Como: usar um suplemento para especificar ícones de uma área de formulário.

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. Com base nesses dados, se o Outlook avisos que um suplemento foi especificado para fornecer o manifesto XML para uma área de formulário, o Outlook usará o ProgID fornecido nos dados armazenados em cache e o método GetFormRegionManifest implementado por este suplemento para obter o XML que ele precisa exibir a área de formulário de chamada. Se o manifesto XML não é válido e não está de acordo com o esquema XML de região de formulário, o Outlook não poderão carregar a região do formulário. Além disso, se você não especificar nenhum ProgID no registro do Windows, o Outlook não chamará os métodos GetFormRegionManifest e GetFormRegionIcon .

O Outlook ignora os seguintes elementos quando o suplemento fornece o manifesto XML:

  • nome : o Outlook ignora o valor especificado para esse elemento e usará o nome especificado para a região do formulário no registro.

  • layoutFile : o Outlook ignora esse elemento porque um suplemento está estendendo essa região de formulário.

  • addin : o Outlook usa o valor precedido por um sinal igual (=) no registro como o ProgID do suplemento.

  • atributo de arquivo de stringOverride : o Outlook ignora qualquer arquivo de localização secundário especificado pelo elemento stringOverride. O suplemento pode implementar GetFormRegionManifest para retornar inline o manifesto XML para localização de cadeia de caracteres para o LCID especificado ou gerenciar a localização de cadeia de caracteres de outra maneira, por exemplo, usando .NET Framework localização e retornar o manifesto XML apropriado para o LCID especificado.

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.