Compartilhar via


_FormRegionStartup.GetFormRegionManifest(String, Int32) Método

Definição

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

public:
 System::Object ^ GetFormRegionManifest(System::String ^ FormRegionName, int LCID);
public object GetFormRegionManifest (string FormRegionName, int LCID);
Public Function GetFormRegionManifest (FormRegionName As String, LCID As Integer) 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.

Retornos

Um objeto que representa o manifesto XML para uma região de 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 FormRegionStartup interface, esse método e o método fornecem um mecanismo por meio do GetFormRegionIcon(String, Int32, OlFormRegionIcon) 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ê deseja que um suplemento fornece manifesto XML para uma região do formulário, especifique o ProgID do suplemento ao registrar a região do 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 método GetFormRegionManifest do Registro do Windows da interface FormRegionStartup. Observe que se você não especificar um 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 como usar um suplemento para especificar ícones, consulte Como usar um suplemento para especificar ícones para uma região 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 qualquer ProgID no registro do Windows, o Outlook não chame os métodos GetFormRegionManifest e GetFormRegionIcon.

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

Aplica-se a