Compartilhar via

Passo a passo: criar sua primeira personalização no nível do documento para o Excel

Este passo a passo introdutório mostra como criar uma personalização no nível do documento para o Microsoft Office Excel. Os recursos que você cria nesse tipo de solução só estão disponíveis quando uma pasta de trabalho específica está aberta. Você não pode usar uma personalização no nível do documento para fazer alterações em todo o aplicativo, por exemplo, exibindo uma nova guia Faixa de Opções quando qualquer pasta de trabalho está 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 Os recursos disponíveis pelo aplicativo do Office e pelo tipo de projeto.

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.

  • Escrevendo código que usa o modelo de objeto do Excel para adicionar texto à planilha personalizada quando ele é aberto.

  • Compilar e executar o projeto para testá-lo.

  • Limpar o projeto concluído para remover arquivos de build 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, consulte 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 Novo e clique em Projeto.

  3. Na caixa de diálogo Criar um Novo Projeto , selecione o projeto da 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 o Excel mostrará todos os modelos de projeto do Excel. Você também pode filtrar a lista de modelos para mostrar apenas os modelos do Office selecionando o Office na caixa suspensa tipo Projeto. Para obter mais informações, consulte Criar um novo projeto no Visual Studio.

  4. Clique em Próximo.

  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 de Projeto das Ferramentas do Visual Studio para Office e clique em OK.

    • O 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 (.vb arquivo para Visual Basic ou .cs arquivo para Visual C#) – uma planilha que fornece a superfície de design e o código da primeira planilha na pasta de trabalho. Para obter mais informações, consulte o item de host da Planilha.

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

    • Sheet3 (.vb arquivo para Visual Basic ou .cs arquivo 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 de Visual Basic ou arquivo .cs de Visual C#) – contém a superfície de design e o código para personalizações no nível da pasta de trabalho. Para obter mais informações, consulte o item host do workbook.

      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 projetar a interface do usuário da sua personalização modificando a planilha aberta no designer. Por exemplo, você pode adicionar texto às 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 Sheet1 classe, que representa o modelo de programação da planilha e fornece acesso ao modelo de objeto do Excel. Para obter mais informações, veja Item host da Planilha e Visão geral do modelo de objeto do Word. O restante da Sheet1 classe é definido em um arquivo de código oculto que você não deve modificar.

  • Os manipuladores de eventos Sheet1_Startup 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 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 Planilha1 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 associado à pasta de trabalho. O Visual Studio coloca uma cópia da pasta de trabalho e do assembly na pasta de saída de build do projeto e define as configurações de segurança no computador de desenvolvimento para permitir que a personalização seja executada. Para obter mais informações, consulte Criar soluções do Office.

  2. Na pasta de trabalho, verifique se o seguinte texto está visível.

    Este texto foi adicionado usando o designer.

    Este texto foi adicionado usando o código.

  3. Feche a pasta de trabalho.

Limpar o projeto

Ao concluir o desenvolvimento de um projeto, você deve remover os arquivos na pasta de saída de build e as configurações de segurança criadas pelo processo de build.

Para limpar o projeto concluído em seu 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 no nível de documento para o Excel, saiba mais sobre como desenvolver personalizações a partir destes tópicos:

Conteúdo relacionado

  • Last updated on