Demonstra Passo a passo: Sincronizar um painel de tarefas personalizado com um botão Faixa de Opções

Este passo a passo demonstra como criar um painel de tarefas personalizado que os usuários podem ocultar ou exibir clicando em um botão de alternância na faixa de opções. Você sempre deve criar um elemento de interface do usuário (UI), como um botão, no qual os usuários podem clicar para exibir ou ocultar seu painel de tarefas personalizado, porque os aplicativos do Microsoft Office não fornecem uma maneira padrão para os usuários mostrarem ou ocultarem painéis de tarefas personalizados.

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.

Embora este passo a passo use o Excel especificamente, os conceitos demonstrados pelo passo a passo são aplicáveis a todos os aplicativos listados acima.

Este passo a passo ilustra as seguintes tarefas:

• Criando a interface do usuário do painel de tarefas personalizado.

• Adicionar um botão de alternância à Faixa de Opções.

• Sincronizar o botão de alternância com o painel de tarefas personalizado.

Observação

Seu computador pode mostrar diferentes nomes ou locais para alguns dos elementos de interface do usuário do Visual Studio nas instruções a seguir. A edição do Visual Studio que você possui e as configurações que você usa determinam esses elementos. Para obter mais informações, confira Personalizar o IDE do Visual Studio.

Pré-requisitos

Você precisará dos seguintes componentes para concluir este passo a passo:

• Uma edição do Visual Studio que inclui o Microsoft Office Developer Tools. Para obter mais informações, consulte Configurar um computador para desenvolver soluções do Office.

• Microsoft Excel ou Microsoft Excel 2013 .

Criar o projeto de suplemento

Nesta etapa, você criará um projeto de suplemento VSTO para Excel.

Criar um novo projeto

1. Crie um projeto de suplemento do Excel com o nome SynchronizeTaskPaneAndRibbon, usando o modelo de projeto de suplemento do Excel. Para obter mais informações, consulte Como: Criar projetos do Office no Visual Studio.

   O Visual Studio abre o arquivo de código ThisAddIn.cs ou ThisAddIn.vb e adiciona o projeto SynchronizeTaskPaneAndRibbon ao Gerenciador de Soluções.

Adicionar um botão de alternância à faixa de opções

Uma das diretrizes de design de aplicativo do Office é que os usuários sempre devem ter controle da interface do usuário do aplicativo do Office. Para permitir que os usuários controlem o painel de tarefas personalizado, você pode adicionar um botão de alternância da Faixa de Opções que mostra e oculta o painel de tarefas. Para criar um botão de alternância, adicione um item da Faixa de Opções (Visual Designer) ao projeto. O designer ajuda você a adicionar e posicionar controles, definir propriedades de controle e manipular eventos de controle. Para obter mais informações, consulte Designer da faixa de opções.

Para adicionar um botão de alternância à faixa de opções

1. No menu Projeto , clique em Adicionar Novo Item.

2. Na caixa de diálogo Adicionar Novo Item, selecione Faixa de Opções (Visual Designer).

3. Altere o nome da nova Faixa de Opções para ManageTaskPaneRibbon e clique em Adicionar.

   O arquivo ManageTaskPaneRibbon.cs ou ManageTaskPaneRibbon.vb é aberto no Designer da Faixa de Opções e exibe uma guia e um grupo padrão.

4. No Designer da Faixa de Opções, clique em group1.

5. Na janela Propriedades, defina a propriedade Label como Gerenciador do Painel de Tarefas.

6. Na guia Controles da Faixa de Opções do Office da Caixa de Ferramentas, arraste um ToggleButton para o grupo Gerenciador do Painel de Tarefas.

7. Clique em toggleButton1.

8. Na janela Propriedades, defina a propriedade Label como Mostrar Painel de Tarefas.

Criar a interface do usuário do painel de tarefas personalizado

Não há um designer visual para painéis de tarefas personalizados, mas você pode criar um controle de usuário com o layout desejado. Mais adiante neste passo a passo, você adicionará o controle de usuário ao painel de tarefas personalizado.

Para projetar a interface do usuário do painel de tarefas personalizado

1. No menu Project , clique em Adicionar controle de usuário .

2. Na caixa de diálogo Adicionar Novo Item, altere o nome do controle de usuário para TaskPaneControl e clique em Adicionar.

   O controle de usuário será aberto no designer.

3. Na guia Controles comuns da caixa de ferramentas, arraste um controle TextBox para o controle de usuário.

Criar o painel de tarefas personalizado

Para criar o painel de tarefas personalizado quando o Suplemento VSTO for iniciado, adicione o controle de usuário ao painel de tarefas no Startup manipulador de eventos do Suplemento VSTO. Por padrão, o painel de tarefas personalizado não ficará visível. Mais adiante neste passo a passo, você adicionará código que exibirá ou ocultará o painel de tarefas quando o usuário clicar no botão de alternância adicionado à faixa de opções.

Para criar o painel de tarefas personalizado

1. No Gerenciador de Soluções, expanda Excel.

2. Clique com o botão direito do mouse em ThisAddIn.cs ou ThisAddIn.vb e clique em Exibir código.

3. Adicione o código a seguir à classe ThisAddIn . Este código declara uma instância de TaskPaneControl como membro do ThisAddIn.

   C#

   private TaskPaneControl taskPaneControl1;
   private Microsoft.Office.Tools.CustomTaskPane taskPaneValue;
   

   VB

   Private taskPaneControl1 As TaskPaneControl
   Private WithEvents taskPaneValue As Microsoft.Office.Tools.CustomTaskPane
   

4. Substitua o ThisAddIn_Startup manipulador de eventos pelo código a seguir. Esse código adiciona o objeto ao campo, mas não exibe o TaskPaneControl painel de tarefas personalizado (por padrão, a Visible CustomTaskPane propriedade da classe é false).CustomTaskPanes O código Visual C# também anexa um manipulador de eventos para o VisibleChanged evento.

   C#

   private void ThisAddIn_Startup(object sender, System.EventArgs e)
   {
       taskPaneControl1 = new TaskPaneControl();
       taskPaneValue = this.CustomTaskPanes.Add(
           taskPaneControl1, "MyCustomTaskPane");
       taskPaneValue.VisibleChanged +=
           new EventHandler(taskPaneValue_VisibleChanged);
   }
   

   VB

   Private Sub ThisAddIn_Startup(ByVal sender As Object, _
       ByVal e As System.EventArgs) Handles Me.Startup
   
       taskPaneControl1 = New TaskPaneControl()
       taskPaneValue = Me.CustomTaskPanes.Add( _
           taskPaneControl1, "MyCustomTaskPane")
   End Sub
   

5. Adicione o método a seguir à classe ThisAddIn. Esse método manipula o VisibleChanged evento. Quando o usuário fecha o painel de tarefas clicando no botão Fechar (X), esse método atualiza o estado do botão de alternância na Faixa de Opções.

   C#

   private void taskPaneValue_VisibleChanged(object sender, System.EventArgs e)
   {
       Globals.Ribbons.ManageTaskPaneRibbon.toggleButton1.Checked = 
           taskPaneValue.Visible;
   }
   

   VB

   Private Sub taskPaneValue_VisibleChanged(ByVal sender As Object, _
       ByVal e As System.EventArgs) Handles taskPaneValue.VisibleChanged
   
       Globals.Ribbons.ManageTaskPaneRibbon.ToggleButton1.Checked = taskPaneValue.Visible
   End Sub
   

6. Adicione a seguinte propriedade à ThisAddIn classe. Essa propriedade expõe o objeto particular taskPaneValue a outras classes. Mais adiante nesta explicação passo a passo, você adicionará código à MyRibbon classe que usa essa propriedade.

   C#

   public Microsoft.Office.Tools.CustomTaskPane TaskPane
   {
       get
       {
           return taskPaneValue;
       }
   }
   

   VB

   Public ReadOnly Property TaskPane() As Microsoft.Office.Tools.CustomTaskPane
       Get
           Return taskPaneValue
       End Get
   End Property
   

Ocultar e mostrar o painel de tarefas personalizado usando o botão de alternância

A última etapa é adicionar código que exibe ou oculta o painel de tarefas personalizado quando o usuário clica no botão de alternância na Faixa de Opções.

Para exibir e ocultar o painel de tarefas personalizado usando o botão de alternância

1. No Designer da Faixa de Opções, clique duas vezes no botão de alternância Mostrar Painel de Tarefas.

   O Visual Studio gera automaticamente um manipulador de eventos chamado toggleButton1_Click, que manipula o Click evento do botão de alternância. O Visual Studio também abre o arquivo MyRibbon.cs ou MyRibbon.vb no Editor de códigos.

2. Substitua o toggleButton1_Click manipulador de eventos pelo código a seguir. Quando o usuário clica no botão de alternância, esse código exibe ou oculta o painel de tarefas personalizado, dependendo se o botão de alternância é pressionado ou não pressionado.

   C#

   private void toggleButton1_Click(object sender, RibbonControlEventArgs e)
   {
       Globals.ThisAddIn.TaskPane.Visible = ((RibbonToggleButton)sender).Checked;
   }
   

   VB

   Private Sub ToggleButton1_Click(ByVal sender As System.Object, _
       ByVal e As Microsoft.Office.Tools.Ribbon.RibbonControlEventArgs) Handles ToggleButton1.Click
   
       Globals.ThisAddIn.TaskPane.Visible = _
           TryCast(sender, Microsoft.Office.Tools.Ribbon.RibbonToggleButton).Checked
   End Sub
   

Testar o suplemento

Quando você executa o projeto, o Excel é aberto sem exibir o painel de tarefas personalizado. Clique no botão de alternância na faixa de opções para testar o código.

Para testar o suplemento VSTO

1. Pressione F5 para executar o projeto.

   Confirme se o Excel é aberto e a guia Suplementos aparece na faixa de opções.

2. Clique na guia Suplementos na faixa de opções.

3. No grupo Gerenciador do Painel de Tarefas, clique no botão de alternância Mostrar Painel de Tarefas.

   Verifique se o painel de tarefas é exibido alternadamente e oculto quando você clica no botão de alternância.

4. Quando o painel de tarefas estiver visível, clique no botão Fechar (X) no canto do painel de tarefas.

   Verifique se o botão de alternância parece não estar pressionado.

Próximas etapas

Você pode saber mais sobre como criar painéis de tarefas personalizados a partir destes tópicos:

• Crie um painel de tarefas personalizado em um suplemento VSTO para um aplicativo diferente. Para obter mais informações sobre os aplicativos que oferecem suporte a painéis de tarefas personalizados, consulte Painéis de tarefas personalizados.

• Automatizar um aplicativo a partir de um painel de tarefas personalizado. Para obter mais informações, consulte Demonstra Passo a passo: automatizar um aplicativo a partir de um painel de tarefas personalizado.

• Crie um painel de tarefas personalizado para cada mensagem de email aberta no Outlook. Para obter mais informações, consulte Demonstra Passo a passo: Exibir painéis de tarefas personalizados com mensagens de email no Outlook.

Conteúdo relacionado

• Painéis de tarefas personalizados
• Como adicionar um painel de tarefas personalizado a um aplicativo
• Demonstra Passo a passo: Automatizar um aplicativo a partir de um painel de tarefas personalizado
• Passo a passo: Exibir painéis de tarefas personalizados com mensagens de email no Outlook
• Visão geral da faixa de opções