Demonstra Passo a passo: Chamar o código do VBA em um projeto do Visual C#

Artigo
08/08/2011

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

Aplicável a: As informações neste tópico se aplicam a projetos de nível de documento para os seguintes aplicativos: Excel 2007 e Excel 2010; Word 2007 e Word 2010. Para obter mais informações, consulte Recursos disponíveis pelo aplicativo do Office e o tipo de projeto.

Embora este passo a passo usa o Excel especificamente, os conceitos demonstrados pela explicação também são aplicáveis aos projetos de nível de documento do Word.

This walkthrough illustrates the following tasks:

Criar uma pasta de trabalho que contém o código do VBA.
Confiando o local da pasta de trabalho usando a Central de confiabilidade no Excel.
Adicionando um método para o Sheet1 classe. item de host
Extraindo uma interface para o Sheet1 classe. item de host
Expondo o método para o código do VBA.
Chamando o método do código do VBA.

Observação
Your computer might show different names or locations for some of the Visual Studio user interface elements in the following instructions. The Visual Studio edition that you have and the settings that you use determine these elements. For more information, see Trabalhando com configurações.

Pré-requisitos

You need the following components to complete this walkthrough:

Uma edição do Visual Studio 2010 que inclua as ferramentas de desenvolvedor do Microsoft Office. Para obter mais informações, consulte [Configurando um computador para desenvolver soluções do Office](bb398242\(v=vs.100\).md).

Excel 2007 ou Excel 2010.

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

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

Se você já tiver uma pasta de trabalho que contenha código VBA que você deseja usar, você pode ignorar esta etapa.

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

Inicie o Excel.
Salvar o documento ativo como um O trabalho de Excel Macro-Enabled (*.xlsm) com o nome WorkbookWithVBA. Salve-o em um local conveniente, como, por exemplo, a área de trabalho.
Na faixa de opções, clique no Developer guia.

Observação

Se o Developer guia não estiver visível, você deve primeiro mostrá-lo. For more information, see Como: Mostrar guia desenvolvedor na faixa de opções.
No código de grupo, clique em Visual Basic.

O Editor de Visual Basic é aberto.
No projeto janela, clique duas vezes em ThisWorkbook.

O arquivo de código para o ThisWorkbook objeto será aberta.
Adicione o seguinte código do VBA para o arquivo de código. Esse código define uma função simples que não faz nada. A única finalidade desta função é garantir a existência de um projeto VBA da pasta de trabalho. Isso é necessário para etapas posteriores nesta explicação.
```
Sub EmptySub()
End Sub
```
Salve o documento e saia do Excel.

Observação
Se o Developer guia não estiver visível, você deve primeiro mostrá-lo. For more information, see Como: Mostrar guia desenvolvedor na faixa de opções.

Creating the Project

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

Para criar um novo projeto.

Start Visual Studio.
On the File menu, point to New, and then click Project.
No painel templates, expanda **Visual C#**e em seguida, expanda Office.
Selecione o 2010 ou 2007 nó.
Na lista de modelos de projeto, selecione o Pasta de trabalho do Excel project.
No nome caixa, digite CallingCodeFromVBA.
Click OK.

O Visual Studio Tools for Office Project Wizard abre.
Selecione Copiar um documento existentee, no um caminho completo do documento existente , especifique o local da WorkbookWithVBA pasta de trabalho que você criou anteriormente. Se você estiver usando sua própria pasta de trabalho habilitado para macro, especifique o local da pasta de trabalho, em vez disso.
Click Finish.

Visual StudioAbre a WorkbookWithVBA a pasta de trabalho no designer e adiciona a CallingCodeFromVBA de projeto para Solution Explorer.

Confiando o local da pasta de trabalho

Antes de você pode expor o código em sua solução ao código do VBA da pasta de trabalho, você deve confiar em VBA da pasta de trabalho para executar. Há várias maneiras de fazer isso. Nesta explicação, você realizará essa tarefa por confiar a localização da pasta de trabalho na Trust Center no Excel.

Para confiar no local da pasta de trabalho

Inicie o Excel.
Clique o arquivo guia (para Excel 2010) ou o Botão de Microsoft Office (para o Excel 2007).
Clique o Opções do Excel botão.
No painel de categorias, clique em Trust Center.
No painel de detalhes, clique em Configurações da Central de confiabilidade.
No painel de categorias, clique em Locais confiáveis.
No painel de detalhes, clique em Adicionar novo local.
No Local confiável do Microsoft Office caixa de diálogo, navegue até a pasta que contém o projeto CallingCodeFromVBA.
Selecione as subpastas deste local são confiáveis também.
No Local confiável do Microsoft Office caixa de diálogo, clique em OK.
No Trust Center caixa de diálogo, clique em OK.
No Opções do Excel caixa de diálogo, clique em OK.
Sair Excel.

A adição de um método à classe Sheet1

Agora que o projeto VBA estiver configurado, adicionar um método público para o Sheet1 classe de item de host que podem ser chamados a partir do código do VBA.

Para adicionar um método na classe de Sheet1

Em Solution Explorer, com o botão direito Sheet1.cse em seguida, clique em Exibir código.

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

Add the following code to the Sheet1 class. O CreateVstoNamedRange método cria uma nova NamedRange o objeto no intervalo especificado. Esse método também cria um manipulador de eventos para o Selected o evento da NamedRange. Posteriormente neste passo a passo, você chamará o CreateVstoNamedRange método do código do VBA do 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.");
}

Adicione o seguinte método para o Sheet1 classe. Esse método substitui a GetAutomationObject() método para retornar a instância atual da Sheet1 classe.
```
protected override object GetAutomationObject()
{
    return this;
}
```
Aplicar os seguintes atributos antes da primeira linha do Sheet1 declaração de classe. Esses atributos tornam visível a classe COM, mas sem gerar uma interface de classe.
```
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.ClassInterface(
    System.Runtime.InteropServices.ClassInterfaceType.None)]
```

Extraindo uma Interface para a classe de Sheet1

Antes de você pode expor o CreateVstoNamedRange método para o código VBA, você deve criar uma interface pública que define este método, e você deve expor esta interface para COM.

Para extrair uma interface para a classe de Sheet1

No Sheet1.cs o arquivo de código, clique em qualquer lugar do Sheet1 classe.
Sobre o Refactor menu, clique em Extrair Interface.
No Extrair Interface na caixa a Selecionar membros públicos para formar interface caixa, clique na entrada para o CreateVstoNamedRange método.
Click OK.

Visual Studiogera uma nova interface chamada ISheet1, e modifica a definição da Sheet1 de classe para que ele implementa o ISheet1 interface. Visual Studiotambém abre a ISheet1.cs o arquivo no Editor de código.
No ISheet1.cs de arquivo, substitua o ISheet1 a declaração de interface com o código a seguir. Este código faz o ISheet1 interface pública e ele se aplica a ComVisibleAttribute atributo para tornar a interface visível para com.
```
[System.Runtime.InteropServices.ComVisible(true)]
public interface ISheet1
{
    void CreateVstoNamedRange(Microsoft.Office.Interop.Excel.Range range, string name);
}
```
Build the project.

Expor o método para o código do VBA

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

Para expor o método para o código do VBA

Em Solution Explorer, clique duas vezes em Sheet1.cs.

O WorkbookWithVBA arquivo abre no designer, Sheet1 visível.
No Propriedades janela, selecione o ReferenceAssemblyFromVbaProject propriedade e altere o valor para True.
Clique em OK na mensagem que é exibida.
Build the project.

Chamando o método de código do VBA

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

Observação
Esta explicação passo a passo, você irá adicionar código do VBA para a pasta de trabalho durante a depuração do projeto. O código do VBA que você adicionar a este documento será substituído na próxima vez que você constrói o projeto como Visual Studio substitui o documento na pasta de saída de compilação com uma cópia do documento da pasta do projeto principal. Se desejar salvar o código do VBA, você pode copiá-lo para o documento na pasta do projeto. For more information, see Código de chamada personalizações em nível de documento do VBA.

Esta explicação passo a passo, você irá adicionar código do VBA para a pasta de trabalho durante a depuração do projeto. O código do VBA que você adicionar a este documento será substituído na próxima vez que você constrói o projeto como Visual Studio substitui o documento na pasta de saída de compilação com uma cópia do documento da pasta do projeto principal. Se desejar salvar o código do VBA, você pode copiá-lo para o documento na pasta do projeto. For more information, see Código de chamada personalizações em nível de documento do VBA.

Para chamar o método do código do VBA

Pressione F5 para executar seu projeto.
No Developer tab, o código de grupo, clique em Visual Basic.

O Editor de Visual Basic é aberto.
Sobre o Inserir menu, clique em módulo de.
Adicione o seguinte código para o novo módulo.

Este código chama o CreateTable método no assembly de personalização. A macro acessa esse método, usando o modelo global da GetManagedClass método para acessar o Sheet1 classe de item de host que você expostas ao código do VBA. O GetManagedClass método gerado automaticamente quando você definir a ReferenceAssemblyFromVbaProject propriedade 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
```
Press F5.
Pasta de trabalho aberta, clique na célula A1 em Sheet1. Verifique se a caixa de mensagem aparece.
Saia do Excel sem salvar as alterações.

Próximas etapas

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

Chame o código em um item de host em uma personalização de Visual Basic do VBA. Esse processo é diferente do processo C# Visual. For more information, see Demonstra Passo a passo: Chamar o código do VBA em um projeto de Visual Basic.
Chame o código em um suplemento em nível de aplicativo do VBA. For more information, see Demonstra Passo a passo: Chamar o código do VBA em um suplemento em nível de aplicativo.