Share via

Passo a passo: Criar seu primeiro suplemento VSTO para Excel

  • Artigo

Este passo a passo introdutório mostra como criar um suplemento no nível do aplicativo para o Microsoft Office Excel. Os recursos criados nesse tipo de solução estão disponíveis para o próprio aplicativo, independentemente de quais pastas de trabalho estão abertas.

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

Observação

Interessado em desenvolver soluções que estendam a experiência do Office em várias plataformas? Confira o novo modelo de Suplementos do Office. Os Suplementos do Office têm um espaço pequeno em comparação com os suplementos e soluções VSTO, e você pode criá-los usando praticamente qualquer tecnologia de programação da Web, como HTML5, JavaScript, CSS3 e XML.

Este passo a passo ilustra as seguintes tarefas:

  • Criando um projeto de suplemento VSTO do Excel para Excel.

  • Escrever código que usa o modelo de objeto do Excel para adicionar texto a uma pasta de trabalho quando ele é salvo.

  • Construindo e executando o projeto para testá-lo.

  • Limpando o projeto concluído para que o suplemento VSTO não seja mais executado automaticamente no computador de desenvolvimento.

    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.

Pré-requisitos

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

Criar o projeto

Para criar um novo projeto de suplemento VSTO do Excel no Visual Studio

  1. Inicie o Visual Studio.

  2. No menu Arquivo , aponte para Novoe clique em Projeto.

  3. No painel de modelos, expanda Visual C# ou Visual Basic e, em seguida, expanda Office/SharePoint.

  4. No nó Office/SharePoint expandido, selecione o nó Suplementos do Office.

  5. Na lista de modelos de projeto, selecione Suplemento do Excel 2010 ou Suplemento do Excel 2013.

  6. Na caixa Nome, digite FirstExcelAddIn.

  7. Clique em OK.

    Visual Studio cria o projeto FirstExcelAddIn e abre o arquivo de código ThisAddIn no editor.

Escrever código para adicionar texto à pasta de trabalho salva

Em seguida, adicione código ao arquivo de código ThisAddIn. O novo código usa o modelo de objeto do Excel para inserir texto clichê na primeira linha da planilha ativa. A planilha ativa é a planilha que é aberta quando o usuário salva a pasta de trabalho. Por padrão, o arquivo de código ThisAddIn contém o seguinte código gerado:

  • Uma definição parcial da ThisAddIn classe. Essa classe fornece um ponto de entrada para seu código e fornece acesso ao modelo de objeto do Excel. Para obter mais informações, consulte Suplementos do programa VSTO. O restante da classe é definido em um arquivo de ThisAddIn código oculto que você não deve modificar.

  • Os ThisAddIn_Startup manipuladores de eventos e ThisAddIn_Shutdown . Esses manipuladores de eventos são chamados quando o Excel carrega e descarrega o suplemento VSTO. Use esses manipuladores de eventos para inicializar o suplemento VSTO quando ele for carregado e para limpar os recursos usados pelo suplemento quando ele for descarregado. Para obter mais informações, consulte Eventos em projetos do Office.

Para adicionar uma linha de texto à pasta de trabalho salva

  1. No arquivo de código ThisAddIn, adicione o seguinte código à ThisAddIn classe. O novo código define um manipulador de eventos para o WorkbookBeforeSave evento, que é gerado quando uma pasta de trabalho é salva.

    Quando o usuário salva uma pasta de trabalho, o manipulador de eventos adiciona novo texto no início da planilha ativa.

    void Application_WorkbookBeforeSave(Microsoft.Office.Interop.Excel.Workbook Wb, bool SaveAsUI, ref bool Cancel)
{
    Excel.Worksheet activeWorksheet = ((Excel.Worksheet)Application.ActiveSheet);
    Excel.Range firstRow = activeWorksheet.get_Range("A1");
    firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown);
    Excel.Range newFirstRow = activeWorksheet.get_Range("A1");
    newFirstRow.Value2 = "This text was added by using code";
}

  2. Se você estiver usando C#, adicione o seguinte código necessário ao manipulador de ThisAddIn_Startup eventos. Esse código é usado para conectar o manipulador de eventos com o Application_WorkbookBeforeSaveWorkbookBeforeSave evento.

    this.Application.WorkbookBeforeSave += new Microsoft.Office.Interop.Excel.AppEvents_WorkbookBeforeSaveEventHandler(Application_WorkbookBeforeSave);

    Para modificar a pasta de trabalho quando ela é salva, os exemplos de código anteriores usam os seguintes objetos:

  • O Application campo da ThisAddIn classe. O Application campo retorna um Application objeto, que representa a instância atual do Excel.

  • O Wb parâmetro do manipulador de eventos para o WorkbookBeforeSave evento. O Wb parâmetro é um Workbook objeto, que representa a pasta de trabalho salva. Para obter mais informações, consulte Visão geral do modelo de objeto do Excel.

Testar o projeto

Para testar o projeto

  1. Pressione F5 para compilar e executar seu projeto.

    Quando você compila o projeto, o código é compilado em um assembly que está incluído na pasta de saída de compilação para o projeto. O Visual Studio também cria um conjunto de entradas do Registro que permitem que o Excel descubra e carregue o suplemento VSTO e define as configurações de segurança no computador de desenvolvimento para permitir que o suplemento VSTO seja executado. Para obter mais informações, consulte Criar soluções do Office.

  2. No Excel, salve a pasta de trabalho.

  3. Verifique se o texto a seguir foi adicionado à pasta de trabalho.

    Este texto foi adicionado usando código.

  4. Feche o Excel.

Limpar o projeto

Quando terminar de desenvolver um projeto, remova o assembly do suplemento VSTO, as entradas do Registro e as configurações de segurança do computador de desenvolvimento. Caso contrário, o suplemento VSTO continuará a ser executado sempre que você abrir o Excel no computador de desenvolvimento.

Para limpar o projeto concluído no computador de desenvolvimento

  1. No Visual Studio, no menu Compilar , clique em Limpar Solução.

Próximas etapas

Agora que você criou um suplemento VSTO básico para Excel, você pode aprender mais sobre como desenvolver suplementos VSTO a partir destes tópicos:

  • Tarefas gerais de programação que você pode executar em Suplementos VSTO: Suplementos VSTO do Programa.

  • Tarefas de programação específicas dos suplementos VSTO do Excel: soluções do Excel.

  • Usando o modelo de objeto do Excel: visão geral do modelo de objeto do Excel.

  • Personalizar a interface do usuário (UI) do Excel, por exemplo, adicionando uma guia personalizada à Faixa de Opções ou criando seu próprio painel de tarefas personalizado: personalização da interface do usuário do Office.

  • Criando e depurando suplementos VSTO para Excel: crie soluções do Office.

  • Implantando suplementos VSTO para Excel: implante uma solução do Office.

Conteúdo relacionado