Tutorial: Llamar a código de VBA en un proyecto de Visual C#

Actualización: noviembre 2007

Se aplica a

La información de este tema sólo se aplica a los proyectos y versiones especificados de Visual Studio Tools para Office de Microsoft Office.

Tipo de proyecto

  • Proyectos de nivel de documento

Versión de Microsoft Office

  • Microsoft Office System 2007

Para obtener más información, vea Características disponibles por aplicación y tipo de proyecto.

En este tutorial se muestra cómo llamar a un método en una personalización de nivel de documento para Microsoft Office Excel 2007 desde código de Visual Basic para Aplicaciones (VBA) en el libro. El procedimiento implica tres pasos básicos: agregar un método a la clase de elemento host Sheet1, exponer el método a código de VBA en el libro y, a continuación, llamar al método desde código de VBA en el libro.

Aunque este tutorial utiliza específicamente Excel, los conceptos que muestra también son aplicables a los proyectos de nivel de documento para Microsoft Office Word 2007.

Este tutorial ilustra las tareas siguientes:

  • Crear un libro que contenga código de VBA.

  • Confiar en la ubicación del libro utilizando el Centro de confianza en Excel.

  • Agregar un método a la clase de elemento host Sheet1.

  • Extraer una interfaz para la clase de elemento host Sheet1.

  • Exponer el método a código de VBA.

  • Llamar al método desde código de VBA.

Nota:

Es posible que su equipo muestre nombres o ubicaciones diferentes para algunos de los elementos de la interfaz de usuario de Visual Studio en las siguientes instrucciones. La edición de Visual Studio que tenga y la configuración que esté utilizando determinan estos elementos. Para obtener más información, consulte Valores de configuración de Visual Studio.

Requisitos previos

Necesita los componentes siguientes para completar este tutorial:

  • Visual Studio Tools para Office (componente opcional de Visual Studio 2008 Professional y Visual Studio Team System).

  • Microsoft Office Excel 2007.

Visual Studio Tools para Office se instala, de forma predeterminada, con las versiones que se enumeran de Visual Studio. Para comprobar si está instalado, consulte Instalar Visual Studio Tools para Office.

Crear un libro que contenga código de VBA

El primer paso consiste en crear un libro habilitado para macros que contenga una macro de VBA sencilla. Antes de exponer el código en una personalización a VBA, el libro ya debe contener código de VBA. De lo contrario, Visual Studio Tools para Office no puede modificar el proyecto de VBA para permitir que el código de VBA realice llamadas en el ensamblado de Visual Studio Tools para Office.

Si ya tiene un libro que contiene código de VBA que desea utilizar, puede omitir este paso.

Para crear un libro que contenga código de VBA

  1. Inicie Excel 2007.

  2. Guarde el documento activo como un Libro de Excel habilitado para macros (*.xlsm) con el nombre WorkbookWithVBA. Guárdelo en una ubicación conveniente, como el escritorio.

  3. En la cinta de opciones, haga clic en la ficha Desarrollador.

    Nota:

    Si la ficha Desarrollador no está visible, debe mostrarla primero. Para obtener más información, consulte Cómo: Mostrar la ficha Programador en la cinta de opciones.

  4. En el grupo Código, haga clic en Visual Basic.

    Se abre el Editor de Visual Basic.

  5. En la ventana Proyecto, haga doble clic en ThisWorkbook.

    Se abre el archivo de código para el objeto ThisWorkbook.

  6. Agregue el siguiente código de VBA al archivo de código. Este código define una función simple que no hace nada. El único propósito de esta función es asegurarse de que existe un proyecto de VBA en el libro. Esto se requiere para pasos posteriores de este tutorial.

    Sub EmptySub()
End Sub

  7. Guarde el documento y salga de Word.

Creación del proyecto

Ahora puede crear un proyecto de nivel de documento para Excel 2007 que utilice el libro habilitado para macros creado anteriormente.

Para crear un nuevo proyecto

  1. Inicie Visual Studio.

  2. En el menú Archivo, elija Nuevo y, a continuación, haga clic en Proyecto.

  3. En el panel Tipos de proyecto, expanda **Visual C#**y, a continuación, expanda Office.

  4. Seleccione la carpeta 2007.

  5. En el panel Plantillas, seleccione el proyecto Libro de Excel.

  6. En el cuadro Nombre, escriba CallingCodeFromVBA.

  7. Haga clic en Aceptar.

    Se abre el Asistente para proyectos de Visual Studio Tools para Office.

  8. Seleccione Copiar un documento existentey, en el cuadro Ruta de acceso completa al documento existente, especifique la ubicación del libro WorkbookWithVBA que creó anteriormente. Si usa su propio libro habilitado para macros, especifique la ubicación de dicho libro.

  9. Haga clic en Finalizar.

    Visual Studio abre el libro WorkbookWithVBA en el diseñador y agrega el proyecto CallingCodeFromVBA al Explorador de soluciones.

Confiar en la ubicación del libro

Antes de exponer el código de la solución a código de VBA en el libro, debe confiar en VBA en el libro para ejecutarse. Existen varias formas de hacerlo. En este tutorial, logrará esta tarea confiando en la ubicación del libro en el Centro de confianza de Excel.

Para confiar en la ubicación del libro

  1. Inicie Excel.

  2. Haga clic en el botón Microsoft Office.

  3. Haga clic en el botón Opciones de Excel.

  4. En el panel Categorías, haga clic en Centro de confianza.

  5. En el panel Detalles, haga clic en Trust Center Settings.

  6. En el panel de categorías, haga clic en Ubicaciones de confianza.

  7. En el panel de detalles, haga clic en Agregar nueva ubicación.

  8. En el cuadro de diálogo Ubicación de confianza de Microsoft Office, vaya a la carpeta que contiene el proyecto CallingCodeFromVBA.

  9. Seleccione Las subcarpetas de esta ubicación también son de confianza.

  10. En el cuadro de diálogo Ubicación de confianza de Microsoft Office, haga clic en Aceptar.

  11. En el cuadro de diálogo Centro de confianza, haga clic en Aceptar.

  12. En el cuadro de diálogo Opciones de Excel, haga clic en Aceptar.

  13. Salga de Excel.

Agregar un método a la clase Sheet1

Ahora que el proyecto de VBA está configurado, agregue un método público a la clase de elemento host Sheet1 al que pueda llamar desde código de VBA.

Para agregar un método a la clase Sheet1

  1. En el Explorador de soluciones, haga clic con el botón secundario en Sheet1.cs y, a continuación, en Ver código.

    El archivo Sheet1.cs se abre en el editor de código.

  2. Agregue el código siguiente a la clase Sheet1. El método CreateVstoNamedRange crea un nuevo objeto NamedRange en el intervalo especificado. Este método también crea un controlador de eventos para el evento Selected de NamedRange. Más adelante en este tutorial llamará al método CreateVstoNamedRange desde código de VBA en el 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. Agregue el método siguiente a la clase Sheet1. Este método invalida el método GetAutomationObject para devolver la instancia actual de la clase Sheet1.

    protected override object GetAutomationObject()
{
    return this;
}

  4. Aplique los atributos siguientes antes de la primera línea de la declaración de clase Sheet1. Estos atributos hacen que la clase sea visible para COM, pero sin generar una interfaz de clase.

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

Extraer una interfaz para la clase Sheet1

Antes de exponer el método CreateVstoNamedRange a código de VBA, debe crear una interfaz pública que defina este método y debe exponer esta interfaz a COM.

Para extraer una interfaz para la clase Sheet1

  1. En el archivo de código Sheet1.cs, haga clic en cualquier parte de la clase Sheet1.

  2. En el menú Refactorizar, haga clic en Extraer interfaz.

  3. En el cuadro de diálogo Extraer interfaz, en el cuadro Seleccionar miembros públicos para formar la interfaz, haga clic en la entrada del método CreateVstoNamedRange.

  4. Haga clic en Aceptar.

    Visual Studio genera una nueva interfaz denominada ISheet1y modifica la definición de la clase Sheet1 para que implemente la interfaz ISheet1. Visual Studio también abre el archivo ISheet1.cs en el editor de código.

  5. En el archivo ISheet1.cs, reemplace la declaración de interfaz ISheet1 con el código siguiente. Este código hace pública la interfaz ISheet1 y aplica el atributo ComVisibleAttribute para hacer la interfaz visible para COM.

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

  6. Genere el proyecto.

Exponer el método a código de VBA

Para exponer el método CreateVstoNamedRange a código de VBA en el libro, establezca la propiedad ReferenceAssemblyFromVbaProject del elemento host Sheet1 en True.

Para exponer el método a código de VBA

  1. En el Explorador de soluciones, haga doble clic en Sheet1.cs.

    El archivo WorkbookWithVBA se abre en el diseñador, con Sheet1 visible.

  2. En la ventana Propiedades, seleccione la propiedad ReferenceAssemblyFromVbaProject y cambie el valor a True.

  3. Haga clic en Aceptar en el mensaje que aparece.

  4. Genere el proyecto.

Llamar al método desde código de VBA

Ahora puede llamar al método CreateVstoNamedRange desde código de VBA en el libro.

Nota:

En este tutorial, agregará código de VBA al libro a la vez que depura el proyecto. El código de VBA que agregue a este documento se sobrescribirá la próxima vez que genere el proyecto, ya que Visual Studio reemplaza el documento de la carpeta de resultados de la compilación con una copia del documento de la carpeta de proyecto principal. Si desea guardar el código de VBA, puede copiarlo en el documento de la carpeta de proyecto. Para obtener más información, consulte Llamar a código de VBA en personalizaciones de nivel de documento.

Para llamar al método desde código de VBA

  1. Presione F5 para ejecutar el proyecto.

  2. En la ficha Programador, en el grupo Código, haga clic en Visual Basic.

    Se abre el Editor de Visual Basic.

  3. En el menú Insertar, haga clic en Módulo.

  4. Agregue el siguiente código al nuevo módulo.

    Este código llama al método CreateTable del ensamblado de Visual Studio Tools para Office. La macro tiene acceso a este método mediante el método GetManagedClass global para obtener acceso a la clase de elemento host Sheet1 que expuso a código de VBA. El método GetManagedClass se generó automáticamente al establecer la propiedad ReferenceAssemblyFromVbaProject anteriormente en este tutorial.

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

  5. Presione F5.

  6. En el libro abierto, haga clic en la celda A1 de Sheet1. Compruebe que aparece el cuadro de mensaje.

  7. Salga de Excel sin guardar los cambios.

Pasos siguientes

Puede aprender más sobre el código de llamada en soluciones de Visual Studio Tools para Office desde VBA en estos temas:

Vea también

Tareas

Cómo: Exponer código a VBA en un proyecto de Visual Basic

Cómo: Exponer código a VBA en un proyecto de Visual C#

Tutorial: Llamar a código de VBA en un proyecto de Visual Basic

Conceptos

Combinar personalizaciones de VBA y de nivel de documento

Programar personalizaciones de nivel de documento

  • Last updated on