Share via

Demonstra Passo a passo: Criar sua primeira personalização em nível de documento para o Excel

  • Artigo

Este passo a passo introdutório mostra como criar uma personalização em nível de documento para o Microsoft Office Excel. Os recursos criados nesse tipo de solução estão disponíveis somente quando uma pasta de trabalho específica está aberta. Você não pode usar uma personalização em nível de documento para fazer alterações em todo o aplicativo, por exemplo, exibindo uma nova guia da Faixa de Opções quando qualquer pasta de trabalho estiver aberta.

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

Este passo a passo ilustra as seguintes tarefas:

  • Criando um projeto de pasta de trabalho do Excel.

  • Adicionando texto a uma planilha hospedada no designer do Visual Studio.

  • Escrever código que usa o modelo de objeto do Excel para adicionar texto à planilha personalizada quando ela é aberta.

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

  • Limpeza do projeto concluído para remover arquivos de compilação desnecessários e configurações de segurança do 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 pasta de trabalho do Excel no Visual Studio

  1. Inicie o Visual Studio.

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

  3. Na caixa de diálogo Criar um novo projeto, selecione o projeto de pasta de trabalho VSTO do Excel.

    Observação

    Você também pode pesquisar modelos digitando o nome do produto do Office na caixa de texto Pesquisar na parte superior da caixa de diálogo Criar um Novo Projeto . Por exemplo, digitar Excel mostrará todos os modelos de projeto para o Excel . Você também pode filtrar a lista de modelos para mostrar apenas os modelos do Office selecionando Office na caixa suspensa Tipo de projeto. Para obter mais informações, consulte Criar um novo projeto no Visual Studio.

  4. Clique em Avançar.

  5. Digite FirstWorkbookCustomization na caixa Nome na caixa de diálogo Configurar seu novo projeto e clique em Criar.

  6. Selecione Criar um novo documento no Assistente do Visual Studio Tools for Office Project e clique em OK.

    • Visual Studio cria o projeto FirstWorkbookCustomization e adiciona os seguintes arquivos ao projeto.

    • FirstWorkbookCustomization.xlsx - Representa a pasta de trabalho do Excel no projeto. Contém todas as planilhas e gráficos.

    • Sheet1 (arquivo .vb para Visual Basic ou arquivo .cs para Visual C#) - Uma planilha que fornece a superfície de design e o código para a primeira planilha na pasta de trabalho. Para obter mais informações, consulte Item de host de planilha.

    • Sheet2 (arquivo de .vb para Visual Basic ou arquivo .cs para Visual C#) - Uma planilha que fornece a superfície de design e o código para a segunda planilha na pasta de trabalho.

    • Sheet3 (arquivo .vb para Visual Basic ou arquivo .cs para Visual C#) - Uma planilha que fornece a superfície de design e o código para a terceira planilha na pasta de trabalho.

    • ThisWorkbook (arquivo .vb para Visual Basic ou arquivo .cs para Visual C#) - Contém a superfície de design e o código para personalizações em nível de pasta de trabalho. Para obter mais informações, consulte Item de host da pasta de trabalho.

      O arquivo de código Sheet1 é aberto automaticamente no designer.

Fechar e reabrir planilhas no designer

Se você fechar deliberadamente ou acidentalmente uma pasta de trabalho ou uma planilha no designer enquanto estiver desenvolvendo seu projeto, poderá reabri-la.

Para fechar e reabrir uma planilha no designer

  1. Feche a pasta de trabalho clicando no botão Fechar (X) da janela do designer.

  2. No Gerenciador de Soluções, clique com o botão direito do mouse no arquivo de código Sheet1 e clique em Exibir Designer.

    - ou -

    No Gerenciador de Soluções, clique duas vezes no arquivo de código Sheet1 .

Adicionar texto a uma planilha no designer

Você pode criar a interface do usuário (UI) de sua personalização modificando a planilha que está aberta no designer. Por exemplo, você pode adicionar texto a células, aplicar fórmulas ou adicionar controles do Excel. Para obter mais informações sobre como usar o designer, consulte Projetos do Office no ambiente do Visual Studio.

Para adicionar texto a uma planilha usando o designer

  1. Na planilha aberta no designer, selecione a célula A1 e digite o texto a seguir.

    Este texto foi adicionado usando o designer.

Aviso

Se você adicionar essa linha de texto à célula A2, ela será substituída por outro código neste exemplo.

Adicionar texto a uma planilha programaticamente

Em seguida, adicione código ao arquivo de código Sheet1. O novo código usa o modelo de objeto do Excel para adicionar uma segunda linha de texto à pasta de trabalho. Por padrão, o arquivo de código Sheet1 contém o seguinte código gerado:

  • Uma definição parcial da classe, que representa o modelo de programação da Sheet1 planilha e fornece acesso ao modelo de objeto do Excel. Para obter mais informações, Visão geral do item de host da planilha e do modelo de objeto do Word. O restante da classe é definido em um arquivo de Sheet1 código oculto que você não deve modificar.

  • Os Sheet1_Startup manipuladores de eventos e Sheet1_Shutdown . Esses manipuladores de eventos são chamados quando o Excel carrega e descarrega sua personalização. Use esses manipuladores de eventos para inicializar sua personalização quando ela for carregada e para limpar os recursos usados pela personalização quando ela for descarregada. Para obter mais informações, consulte Eventos em projetos do Office.

Para adicionar uma segunda linha de texto à planilha usando código

  1. No Gerenciador de Soluções, clique com o botão direito do mouse em Sheet1 e clique em Exibir Código.

    O arquivo de código é aberto no Visual Studio.

  2. Substitua o Sheet1_Startup manipulador de eventos pelo código a seguir. Quando Sheet1 é aberto, esse código adiciona uma segunda linha de texto à planilha.

    private void Sheet1_Startup(object sender, System.EventArgs e)
{
    Microsoft.Office.Tools.Excel.NamedRange nr =
        this.Controls.AddNamedRange(this.Range["A2"], "NamedRange1");
    nr.Value2 = "This text was added by using code";
}

Testar o projeto

Para testar sua pasta de trabalho

  1. Pressione F5 para compilar e executar seu projeto.

    Quando você cria o projeto, o código é compilado em um assembly que está associado à pasta de trabalho. O Visual Studio coloca uma cópia da pasta de trabalho e do assembly na pasta de saída de compilação para o projeto e define as configurações de segurança no computador de desenvolvimento para permitir a execução da personalização. Para obter mais informações, consulte Criar soluções do Office.

  2. Na pasta de trabalho, verifique se você vê o texto a seguir.

    Este texto foi adicionado usando o designer.

    Este texto foi adicionado usando código.

  3. Feche a pasta de trabalho.

Limpar o projeto

Quando terminar de desenvolver um projeto, você deve remover os arquivos na pasta de saída da compilação e as configurações de segurança criadas pelo processo de compilação.

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 uma personalização básica em nível de documento para o Excel, você pode aprender mais sobre como desenvolver personalizações a partir destes tópicos:

  • Tarefas gerais de programação que você pode executar em personalizações em nível de documento: programe personalizações em nível de documento.

  • Tarefas de programação específicas para personalizações em nível de documento para o 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 do Excel, por exemplo, adicionando uma guia personalizada à Faixa de Opções ou criando seu próprio painel de ações: personalização da interface do usuário do Office.

  • Usando objetos estendidos do Excel fornecidos pelas ferramentas de desenvolvimento do Office no Visual Studio para executar tarefas que não são possíveis usando o modelo de objeto do Excel (por exemplo, hospedar controles gerenciados em documentos e vincular controles do Excel a dados usando o modelo de vinculação de dados do Windows Forms): Automatizar o Excel usando objetos estendidos.

  • Criando e depurando personalizações em nível de documento para o Excel: crie soluções do Office.

  • Implantando personalizações em nível de documento para o Excel: implante uma solução do Office.

Conteúdo relacionado