Criar regiões de formulário do Outlook

  • Artigo

Você pode usar regiões de formulário para personalizar formulários do Microsoft Office Outlook. O Visual Studio fornece ferramentas avançadas que facilitam o design, o desenvolvimento e a depuração de regiões de formulário.

Aplica-se a: As informações neste tópico se aplicam a projetos de suplemento VSTO para Outlook. Para obter mais informações, consulte Recursos disponíveis por aplicativo e tipo de projeto do Office.

Este tópico fornece as seguintes informações:

Vantagens de usar regiões de formulário

As regiões de formulário oferecem muitos aprimoramentos em relação ao desenvolvimento de formulários tradicionais do Outlook:

  • Personalize a página padrão de qualquer formulário padrão.

  • Adicione até 12 páginas extras a qualquer formulário padrão.

  • Substitua ou aprimore qualquer formulário padrão.

  • Exiba a interface do usuário personalizada no Painel de Leitura e em Inspetores.

    Para obter mais informações, consulte Personalizar páginas de formulário e regiões de formulário.

Adicionar uma região de formulário do Outlook ao seu projeto

Você pode usar o assistente Nova área de formulário do Outlook para criar uma nova área de formulário ou importar uma área de formulário que foi criada no Outlook. Além disso, se você tiver uma área de formulário que você usou em outro projeto de suplemento VSTO do Outlook, você pode reutilizar sua região de formulário existente.

Criar uma nova região de formulário usando o assistente

Para criar uma região de formulário, adicione um item de área de formulário do Outlook a um projeto de suplemento VSTO do Outlook. Isso inicia o assistente Nova região de formulário do Outlook.

Use o assistente para indicar se você deseja criar uma nova área de formulário ou importar uma área de formulário que foi projetada no Outlook. Para obter mais informações sobre como criar uma nova região de formulário, consulte Usar o designer de região de formulário. Para obter mais informações sobre como usar uma área de formulário projetada no Outlook, consulte Importar uma área de formulário projetada no Outlook.

Use o assistente para especificar o tipo de região do formulário que você deseja criar. A tabela a seguir descreve cada tipo de região de formulário.

Tipo de região Descrição
Separar Adiciona a região do formulário como uma nova página em um formulário do Outlook.
Adjacente Anexa a região do formulário à parte inferior da página padrão de um formulário do Outlook.
Substituição Adiciona a região do formulário como uma nova página que substitui a página padrão de um formulário do Outlook.
Substituir tudo Substitui todo o formulário do Outlook pela região do formulário.

Você também pode usar o assistente para especificar condições de exibição e selecionar o tipo de formulário a ser estendido. Para obter mais informações, consulte Como: Adicionar uma região de formulário a um projeto de suplemento do Outlook.

As seleções feitas no assistente afetam as opções disponíveis em outras páginas do assistente. Por exemplo, se você selecionar Adjacente ou Separar na página Criar uma Nova Região de Formulário do Outlook, os campos Título e Descrição não estarão disponíveis na página Fornecer texto descritivo e selecione suas preferências de exibição. Isso ocorre porque o Outlook não usa esses campos quando exibe uma região de formulário adjacente ou separada.

Arquivos de região de formulário

Quando você conclui o assistente Nova região de formulário do Outlook, o Visual Studio adiciona automaticamente os seguintes arquivos ao seu projeto:

  • Um arquivo de código de região de formulário. Esse arquivo tem o nome especificado para o item de área de formulário do Outlook na caixa de diálogo Adicionar novo item. Adicione código para manipular eventos de região de formulário a este arquivo.

  • Um arquivo de código do designer de região de formulário. Esse arquivo contém código gerado pelo designer de região do formulário e não deve ser editado diretamente.

  • Um arquivo de armazenamento de formulário do Outlook (.ofs).

    Observação

    Esse arquivo só será adicionado ao projeto se você importar uma região de formulário que foi criada no Outlook.

Classe de fábrica da região do formulário

O arquivo de código de região do formulário contém uma classe parcial que implementa a IFormRegionFactory interface. Esta é a classe de fábrica da região do formulário. A classe de fábrica da região do formulário é responsável por criar novas instâncias da região do formulário.

Você pode encontrar essa classe expandindo a região Form Region Factory .

O assistente Nova Região de Formulário do Outlook adiciona atributos a essa classe que especificam o nome interno da região do formulário e as classes de mensagem que exibem a região do formulário. Você pode modificar esses atributos manualmente depois que o arquivo tiver sido adicionado ao projeto.

A maioria da classe de fábrica da região do formulário é implementada no arquivo de designer de região do formulário. No entanto, o FormRegionInitializing manipulador de eventos é exposto no arquivo de código de região do formulário. Você pode usar esse manipulador de eventos para especificar se o Outlook deve exibir a região do formulário. Para obter mais informações, consulte Manipular eventos de região de formulário.

Adicionar uma região de formulário existente ao seu projeto

Se você tiver uma área de formulário do Outlook que você usou em outro projeto do Outlook, você pode reutilizá-lo em seu projeto atual Outlook VSTO Add-in usando a caixa de diálogo Adicionar Item Existente .

A região de formulário existente deve ter um arquivo de código (.vb ou .cs), não é possível adicionar arquivos de armazenamento de formulário do Outlook (.ofs) usando a caixa de diálogo Adicionar Item Existente. No entanto, você pode criar uma nova região de formulário importando um arquivo de armazenamento de formulário do Outlook. Para obter mais informações, consulte Como: Adicionar uma região de formulário a um projeto de suplemento do Outlook.

Usar o designer de região do formulário

O designer de região de formulário ajuda você a projetar o layout e a aparência de uma região de formulário. Você pode arrastar controles gerenciados para a superfície do designer, clicar duas vezes em controles para abrir manipuladores de eventos e definir propriedades na janela Propriedades .

Observação

Você pode encontrar propriedades que afetam a maneira como a região do formulário aparece no Outlook abaixo do nó Manifesto na janela Propriedades.

O designer de área de formulário estará disponível somente se você selecionar Criar uma Nova Área de Formulário na página Selecione como deseja criar a área de formulário do assistente Nova Região de Formulário do Outlook.

Há três maneiras de abrir o designer de região do formulário:

  • No Gerenciador de Soluções, clique duas vezes no arquivo de código de região do formulário.

  • No Gerenciador de Soluções, clique com o botão direito do mouse no arquivo de código de região do formulário e clique em Exibir Designer.

  • No Gerenciador de Soluções, selecione o arquivo de código de região do formulário e, no menu Exibir, clique em Designer.

    O designer de região de formulário oferece suporte apenas a controles gerenciados. Não é possível adicionar controles nativos do Outlook.

Importar uma região de formulário criada no Outlook

Ao criar no Outlook, você pode adicionar controles nativos do Outlook à região do formulário. Os controles nativos do Outlook permitem que você se associe a dados do Outlook em tempo de design. No entanto, você não pode usar o designer de região de formulário para adicionar controles gerenciados ou alterar o design da região de formulário.

Você pode importar regiões de formulário para um projeto de suplemento VSTO do Outlook usando o assistente Nova área de formulário do Outlook. Na página Selecione como você deseja criar a região do formulário, selecione Importar um arquivo .ofs (Armazenamento de Formulário do Outlook). Em seguida, você pode navegar até o local de um arquivo de armazenamento de formulário (.ofs) do Outlook. (O Outlook salva regiões de formulário como arquivos .ofs .)

O assistente para Nova região de formulário do Outlook copia o arquivo .ofs para o diretório do projeto e adiciona referências de controle ao arquivo de designer de região de formulário. Em seguida, você pode manipular eventos de controle no arquivo de código de região do formulário.

Para manipular eventos em um projeto do Visual Basic, selecione um evento na lista de nomes de método na parte superior do Editor de códigos.

Para manipular eventos em um projeto C#, inscreva-se para controlar eventos no FormRegionShowing método. Para obter mais informações, consulte Como assinar e cancelar a assinatura de eventos (guia de programação em C#).

Você pode alterar as InitializeManifest propriedades da região do formulário no método da classe de fábrica da região do formulário.

Observação

Para importar uma região de formulário, você deve estar trabalhando em um projeto destinado à mesma versão do Outlook que você instalou no computador de desenvolvimento. Por exemplo, se você tiver o Outlook 2010 instalado, a importação de uma região de formulário só funcionará em um projeto criado usando o modelo de projeto Suplemento do Outlook 2010.

Atualizar o design de uma região de formulário importada

Você pode adicionar, remover ou alterar controles na região do formulário. Antes de fazer isso, faça backup de qualquer código adicionado ao arquivo de código de região do formulário. Em seguida, abra o arquivo .ofs no Outlook, modifique a região do formulário e salve as alterações. Use o assistente Nova região de formulário do Outlook para importar o arquivo .ofs modificado. Em seguida, você pode colar seu código no novo arquivo de código de região do formulário.

Adicionar código personalizado a uma região de formulário

O Microsoft.Office.Tools.Outlook namespace fornece acesso a classes que representam a região do formulário, o item do Outlook que exibe a região do formulário e outros itens úteis. O item de área de formulário do Outlook adiciona automaticamente uma referência a esse assembly no projeto e insere a instrução using ou Imports apropriada na parte superior do arquivo de código de região de formulário.

Você pode usar classes, métodos e propriedades no namespace para realizar a Microsoft.Office.Interop.Outlook maioria das tarefas de programação do Outlook. Para obter mais informações sobre o modelo de objeto do Outlook, consulte Visão geral do modelo de objeto do Outlook. Para obter exemplos de tarefas típicas que usam o modelo de objeto do Outlook, consulte Soluções do Outlook.

Manipular eventos de região de formulário

O item Área de formulário do Outlook adiciona automaticamente os três manipuladores de eventos a seguir ao arquivo de código de região do formulário.

Evento Descrição
FormRegionInitializing Ocorre antes da região do formulário ser inicializada. Você pode verificar as condições nesse manipulador de eventos para determinar se o Outlook deve exibir a região do formulário. Para obter mais informações, consulte Como: Impedir que o Outlook exiba uma região de formulário.
FormRegionShowing Ocorre após uma instância da região do formulário ser criada, mas antes da região do formulário ser exibida.
FormRegionClosed Ocorre antes da região do formulário ser fechada.

Compilar o projeto

Quando você cria um projeto de suplemento VSTO do Outlook que contém uma região de formulário, Visual Studio adiciona as seguintes informações ao registro:

  • Uma chave para cada classe de mensagem associada a uma ou mais regiões de formulário.

  • Uma entrada para cada região de formulário e um valor associado que representa o nome do suplemento VSTO do Outlook.

    O Outlook usa essas informações para carregar as regiões do formulário.

Depurar uma região de formulário

Você pode depurar um suplemento VSTO do Outlook que contém uma região de formulário da mesma forma que depuraria outros projetos do Visual Studio. Quando você inicia o depurador do Visual Studio, o Visual Studio inicia automaticamente o Outlook.

Para exibir a região do formulário, você deve abrir o item apropriado do Outlook. Por exemplo, se uma região de formulário adjacente for anexada à parte inferior de um item de email, abra um item de email.

Implantar uma região de formulário

As regiões de formulário são implantadas automaticamente com o suplemento VSTO do Outlook associado. Portanto, você não precisa executar nenhuma tarefa especial para implantar uma região de formulário. Para obter mais informações sobre como implantar suplementos VSTO, consulte Implantar uma solução do Office.

Título Descrição
Diretrizes para criar regiões de formulário do Outlook Fornece informações que podem ajudá-lo a otimizar suas regiões de formulário e evitar possíveis problemas.
Como: Adicionar uma área de formulário a um projeto de suplemento do Outlook Mostra como criar uma região de formulário para estender um formulário padrão ou personalizado do Microsoft Office Outlook usando o assistente Nova Região de Formulário do Outlook.
Associar uma região de formulário a uma classe de mensagem do Outlook Explica como especificar quais itens do Microsoft Office Outlook exibem uma região de formulário associando a área de formulário à classe de mensagem de cada item.
Demonstra Passo a passo: Criar uma região de formulário do Outlook Mostra como criar uma região de formulário personalizada que aparece como uma nova página na janela Inspetor de um item de contato.
Demonstra Passo a passo: Importar uma área de formulário que é projetada no Outlook Mostra como criar uma área de formulário no Microsoft Office Outlook e, em seguida, importar a área de formulário para um projeto de suplemento VSTO do Outlook usando o assistente Nova região de formulário do Outlook.
Acessar uma região de formulário em tempo de execução Descreve como escrever código para mostrar, ocultar ou modificar controles em uma região de formulário e permitir que os usuários executem o código de outras áreas em seu projeto usando a Globals classe.
Como: Impedir que o Outlook exiba uma região de formulário Mostra como impedir que o Microsoft Office Outlook exiba uma região de formulário para um item específico.
Mostra como acessar o item do Outlook no qual uma região de formulário aparece.
Ações personalizadas em regiões de formulário do Outlook Descreve como permitir que os usuários respondam a um item do Outlook.