Demonstra Passo a passo: Código de chamada do VBA em um projeto Visual C#

Este passo a passo demonstra como chamar um método em uma personalização em nível de documento para o Microsoft Office Excel a partir do código VBA (Visual Basic for Applications) na pasta de trabalho. O procedimento envolve três etapas básicas: adicionar um método à classe de item de host, expor o método ao código VBA na pasta de trabalho e, em seguida, chamar o método do código VBA na pasta de Sheet1 trabalho.

Aplica-se a: As informações neste tópico se aplicam a projetos de nível de documento para Excel e Word. 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 também são aplicáveis a projetos de nível de documento para o Word.

Este passo a passo ilustra as seguintes tarefas:

• Criando uma pasta de trabalho que contém código VBA.

• Confiar no local da pasta de trabalho usando a Central de Confiabilidade no Excel.

• Adicionando um método à classe de item do Sheet1 host.

• Extraindo uma interface para a classe de item do Sheet1 host.

• Expondo o método ao código VBA.

• Chamando o método do código VBA.

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

Criar uma pasta de trabalho que contém código VBA

A primeira etapa é criar uma pasta de trabalho habilitada para macro que contenha uma macro VBA simples. Antes de expor o código em uma personalização para o VBA, a pasta de trabalho já deve conter o código VBA. Caso contrário, o Visual Studio não pode modificar o projeto VBA para habilitar o código VBA para chamar o assembly de personalização.

Se você já tiver uma pasta de trabalho que contém o código VBA que deseja usar, ignore esta etapa.

Para criar uma pasta de trabalho que contém código VBA

1. Inicie o Excel.

2. Salve o documento ativo como uma pasta de trabalho habilitada para macro do Excel (*.xlsm) com o nome WorkbookWithVBA. Salve-o em um local conveniente, como a área de trabalho.

3. Na Faixa de Opções, clique na guia Desenvolvedor .

   Observação

   Se a guia Desenvolvedor não estiver visível, você deverá mostrá-la primeiro. Para obter mais informações, consulte Como mostrar a guia do desenvolvedor na faixa de opções.

4. No grupo Código, clique em Visual Basic.

   O Editor do Visual Basic é aberto.

5. Na janela Projeto, clique duas vezes em ThisWorkbook.

   O arquivo de código para o ThisWorkbook objeto é aberto.

6. Adicione o seguinte código VBA ao arquivo de código. Esse código define uma função simples que não faz nada. A única finalidade dessa função é garantir que um projeto VBA exista na pasta de trabalho. Isso é necessário para etapas posteriores neste passo a passo.

   Sub EmptySub()
   End Sub
   

7. Salve o documento e saia do Excel.

Criar o projeto

Agora você pode criar um projeto de nível de documento para o Excel que usa a pasta de trabalho habilitada para macro criada anteriormente.

Criar um novo projeto

1. Inicie o Visual Studio.

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

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

4. Selecione o nó Suplementos do Office.

5. Na lista de modelos de projeto, selecione o projeto Pasta de Trabalho do Excel 2010 ou Pasta de Trabalho do Excel 2013.

6. Na caixa Nome, digite CallingCodeFromVBA.

7. Clique em OK.

   O Assistente do Visual Studio Tools for Office Project é aberto.

8. Selecione Copiar um documento existente e, na caixa Caminho completo do documento existente, especifique o local da pasta de trabalho WorkbookWithVBA que você criou anteriormente. Se você estiver usando sua própria pasta de trabalho habilitada para macro, especifique o local dessa pasta de trabalho.

9. Clique em Concluir.

   O Visual Studio abre a pasta de trabalho WorkbookWithVBA no designer e adiciona o projeto CallingCodeFromVBA ao Gerenciador de Soluções.

Confiar no local da pasta de trabalho

Antes de expor o código em sua solução ao código VBA na pasta de trabalho, você deve confiar no VBA na pasta de trabalho a ser executada. Há várias maneiras de fazer isso. Neste passo a passo, você realizará essa tarefa confiando no local da pasta de trabalho na Central de Confiabilidade no Excel.

Para confiar no local da pasta de trabalho

1. Inicie o Excel.

2. Clique na guia Arquivo .

3. Clique no botão Opções do Excel.

4. No painel de categorias, clique em Central de Confiabilidade.

5. No painel de detalhes, clique em Configurações da Central de Confiabilidade.

6. No painel de categorias, clique em Locais Confiáveis.

7. No painel de detalhes, clique em Adicionar novo local.

8. Na caixa de diálogo Local Confiável do Microsoft Office, navegue até a pasta que contém o projeto CallingCodeFromVBA.

9. Selecione Subpastas deste local também são confiáveis.

10. Na caixa de diálogo Local Confiável do Microsoft Office, clique em OK.

11. Na caixa de diálogo Central de Confiabilidade, clique em OK.

12. Na caixa de diálogo Opções do Excel, clique em OK.

13. Saia do Excel.

Adicionar um método à classe Sheet1

Agora que o projeto VBA está configurado, adicione um método público à Sheet1 classe de item de host que você pode chamar do código VBA.

Para adicionar um método à classe Sheet1

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

   O arquivo Sheet1.cs é aberto no Editor de códigos.

2. Adicione o código a seguir à classe Sheet1 . O CreateVstoNamedRange método cria um novo NamedRange objeto no intervalo especificado. Esse método também cria um manipulador de eventos para o Selected evento do NamedRange. Mais adiante neste passo a passo, você chamará o CreateVstoNamedRange método do código VBA no documento.

   private Microsoft.Office.Tools.Excel.NamedRange namedRange1;
   
   public void CreateVstoNamedRange(Excel.Range range, string name)
   {
       if (!this.Controls.Contains(name))
       {
           namedRange1 = this.Controls.AddNamedRange(range, name);
           namedRange1.Selected += new Excel.DocEvents_SelectionChangeEventHandler(
                   namedRange1_Selected);
       }
       else
       {
           MessageBox.Show("A named range with this specific name " +
               "already exists on the worksheet.");
       }
   }
   
   private void namedRange1_Selected(Microsoft.Office.Interop.Excel.Range Target)
   {
       MessageBox.Show("This named range was created by Visual Studio " +
           "Tools for Office.");
   }
   

3. Adicione o método a seguir à classe Sheet1. Esse método substitui o GetAutomationObject método para retornar a instância atual da Sheet1 classe.

   protected override object GetAutomationObject()
   {
       return this;
   }
   

4. Aplique os seguintes atributos antes da primeira linha da Sheet1 declaração de classe. Esses atributos tornam a classe visível para COM, mas sem gerar uma interface de classe.

   [System.Runtime.InteropServices.ComVisible(true)]
   [System.Runtime.InteropServices.ClassInterface(
       System.Runtime.InteropServices.ClassInterfaceType.None)]
   

Extrair uma interface para a classe Sheet1

Antes de expor o CreateVstoNamedRange método ao código VBA, você deve criar uma interface pública que defina esse método e expor essa interface ao COM.

Para extrair uma interface para a classe Sheet1

1. No arquivo de código Sheet1.cs, clique em qualquer lugar da Sheet1 classe.

2. No menu Refatorar, clique em Extrair Interface.

3. Na caixa de diálogo Extrair Interface, na caixa Selecionar membros públicos para a interface de formulário, clique na entrada do CreateVstoNamedRange método.

4. Clique em OK.

   Visual Studio gera uma nova interface chamada ISheet1e modifica a Sheet1 definição da classe para que ele implementa a ISheet1 interface. O Visual Studio também abre o arquivo ISheet1.cs no Editor de códigos.

5. No arquivo ISheet1.cs, substitua a declaração de interface pelo código a ISheet1 seguir. Esse código torna a interface pública e aplica o ComVisibleAttribute atributo para tornar a ISheet1 interface visível para COM.

   [System.Runtime.InteropServices.ComVisible(true)]
   public interface ISheet1
   {
       void CreateVstoNamedRange(Microsoft.Office.Interop.Excel.Range range, string name);
   }
   

6. Compile o projeto.

Expor o método ao código VBA

Para expor o método ao código VBA na pasta de trabalho, defina a propriedade ReferenceAssemblyFromVbaProject para o CreateVstoNamedRange Sheet1 item de host como True.

Para expor o método ao código VBA

1. No Gerenciador de Soluções, clique duas vezes em Sheet1.cs.

   O arquivo WorkbookWithVBA é aberto no designer, com Sheet1 visível.

2. Na janela Propriedades, selecione a propriedade ReferenceAssemblyFromVbaProject e altere o valor para True.

3. Clique em OK na mensagem exibida.

4. Compile o projeto.

Chame o método do código VBA

Agora você pode chamar o CreateVstoNamedRange método do código VBA na pasta de trabalho.

Observação

Nesta explicação passo a passo, você adicionará código VBA à pasta de trabalho ao depurar o projeto. O código VBA adicionado a este documento será substituído na próxima vez que você criar o projeto, porque o Visual Studio substitui o documento na pasta de saída de compilação por uma cópia do documento da pasta principal do projeto. Se você quiser salvar o código VBA, você pode copiá-lo para o documento na pasta do projeto. Para obter mais informações, consulte Combinar VBA e personalizações em nível de documento.

Para chamar o método do código VBA

1. Pressione F5 para executar o projeto.

2. Na guia Desenvolvedor, no grupo Código, clique em Visual Basic.

   O Editor do Visual Basic é aberto.

3. No menu Inserir, clique em Módulo.

4. Adicione o seguinte código ao novo módulo.

   Esse código chama o CreateTable método no assembly de personalização. A macro acessa esse método usando o método global GetManagedClass para acessar a classe de item de Sheet1 host que você expôs ao código VBA. O GetManagedClass método foi gerado automaticamente quando você definiu a propriedade ReferenceAssemblyFromVbaProject anteriormente nesta explicação passo a passo.

   Sub CallVSTOMethod()
       Dim VSTOSheet1 As CallingCodeFromVBA.Sheet1
       Set VSTOSheet1 = GetManagedClass(Sheet1)
       Call VSTOSheet1.CreateVstoNamedRange(Sheet1.Range("A1"), "VstoNamedRange")
   End Sub
   

5. Pressione F5.

6. Na pasta de trabalho aberta, clique na célula A1 da Planilha1. Verifique se a caixa de mensagem é exibida.

7. Saia do Excel sem salvar suas alterações.

Próximas etapas

Você pode saber mais sobre o código de chamada em soluções do Office do VBA nestes tópicos:

• Chamar código em um item de host em uma personalização do Visual Basic do VBA. Esse processo é diferente do processo do Visual C#. Para obter mais informações, consulte Demonstra Passo a passo: código de chamada do VBA em um projeto do Visual Basic.

• Código de chamada em um suplemento VSTO do VBA. Para obter mais informações, consulte Demonstra Passo a passo: Código de chamada em um suplemento VSTO do VBA.

Conteúdo relacionado

• Combinar VBA e personalizações em nível de documento
• Personalizações em nível de documento do programa
• Como: Expor código para VBA em um projeto do Visual Basic
• Como: Expor código para VBA em um projeto Visual C#
• Demonstra Passo a passo: Código de chamada do VBA em um projeto do Visual Basic