Compartir a través de

Tutorial: Creación del primer complemento de VSTO para Excel

  • Artículo

Este tutorial introductorio muestra cómo crear un complemento de nivel de aplicación para Microsoft Office Excel. Las características que cree en este tipo de solución estarán disponibles para la propia aplicación, con independencia de los libros que se abran.

Se aplica a: La información de este tema se aplica a los proyectos de complementos de VSTO para Excel. Para obtener más información, consulte Características disponibles por aplicación de Office lication y tipo de proyecto.

Nota:

¿Le interesa desarrollar soluciones que amplíen la experiencia de Office en varias plataformas? Consulte el nuevo modelo de complementos de Office. Los complementos de Office tienen una superficie pequeña en comparación con los complementos y soluciones de VSTO, y puede compilarlos mediante casi cualquier tecnología de programación web, como HTML5, JavaScript, CSS3 y XML.

En este tutorial se muestran las tareas siguientes:

  • Crear un proyecto de complemento de VSTO para Excel.

  • Escribir código que usa el modelo de objetos de Excel para agregar texto un libro cuando se guarda.

  • Compilar y ejecutar el proyecto para probarlo.

  • Limpiar el proyecto completado para que el complemento de VSTO deje de ejecutarse automáticamente en el equipo de desarrollo.

    Nota:

    Es posible que tu 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 se tenga y la configuración que se utilice determinan estos elementos. Para obtener más información, vea Personalizar el IDE.

Requisitos previos

Necesitará los componentes siguientes para completar este tutorial:

Creación del proyecto

Para crear un nuevo proyecto de complemento de VSTO en Visual Studio

  1. Inicie Visual Studio.

  2. En el menú Archivo , elija Nuevoy haga clic en Proyecto.

  3. En el panel de plantillas, expanda Visual C# o Visual Basicy luego expanda Office/SharePoint.

  4. En el nodo Office/SharePoint expandido, seleccione el nodo Complementos de Office .

  5. En la lista de plantillas de proyecto, seleccione Complemento de Excel 2010 o Complemento de Excel 2013.

  6. En el cuadro Nombre , escriba FirstExcelAddIn.

  7. Haga clic en OK.

    Visual Studio crea el proyecto FirstExcelAddIn y abre el archivo de código ThisAddIn en el editor.

Escribir código para agregar texto al libro guardado

A continuación, agregue código al archivo de código ThisAddIn. El nuevo código utiliza el modelo de objetos de Excel para insertar texto reutilizable en la primera fila de la hoja de cálculo activa. La hoja de cálculo activa es la hoja de cálculo que está abierta cuando el usuario guarda el libro. De forma predeterminada, el archivo de código ThisAddIn contiene el siguiente código generado:

  • Una definición parcial de la clase ThisAddIn . Esta clase proporciona un punto de entrada para el código y proporciona acceso al modelo de objetos de Excel. Para obtener más información, consulte Complementos de VSTO de programa. El resto de la ThisAddIn clase se define en un archivo de código oculto que no debe modificar.

  • Los controladores de eventos ThisAddIn_Startup y ThisAddIn_Shutdown . Se llama a estos controladores de eventos cuando Excel carga y descarga el complemento de VSTO. Use estos controladores de eventos para inicializar el complemento de VSTO cuando se cargue y para limpiar los recursos que usa el complemento cuando se descargue. Para obtener más información, vea Eventos en proyectos de Office.

Para agregar una línea de texto al libro guardado

  1. En el archivo de código ThisAddIn, agregue el código siguiente a la clase ThisAddIn . El nuevo código define un controlador de eventos para el evento WorkbookBeforeSave , que se desencadena cuando se guarda un libro.

    Cuando el usuario guarda un libro, el controlador de eventos agrega el nuevo texto al principio de la hoja de cálculo activa.

    void Application_WorkbookBeforeSave(Microsoft.Office.Interop.Excel.Workbook Wb, bool SaveAsUI, ref bool Cancel)
{
    Excel.Worksheet activeWorksheet = ((Excel.Worksheet)Application.ActiveSheet);
    Excel.Range firstRow = activeWorksheet.get_Range("A1");
    firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown);
    Excel.Range newFirstRow = activeWorksheet.get_Range("A1");
    newFirstRow.Value2 = "This text was added by using code";
}

  2. Si está utilizando C#, agregue el siguiente código necesario para el controlador de eventos ThisAddIn_Startup . Este código se utiliza para conectar el controlador de eventos Application_WorkbookBeforeSave con el evento WorkbookBeforeSave .

    this.Application.WorkbookBeforeSave += new Microsoft.Office.Interop.Excel.AppEvents_WorkbookBeforeSaveEventHandler(Application_WorkbookBeforeSave);

    Para modificar el libro cuando se guarda, los ejemplos de código anteriores utilizan los siguientes objetos:

  • El campo Application de la clase ThisAddIn . El campo Application devuelve un objeto Application que representa la instancia actual de Excel.

  • El parámetro Wb del controlador de eventos para el evento WorkbookBeforeSave . El parámetro Wb es un objeto Workbook que representa el libro guardado. Para obtener más información, vea Información general sobre el modelo de objetos de Excel.

Prueba del proyecto

Para probar el proyecto

  1. Presione F5 para compilar y ejecutar el proyecto.

    Al compilar el proyecto, el código se compila en un ensamblado que se incluye en la carpeta de salida de compilación del proyecto. Visual Studio crea también un conjunto de entradas del registro que permiten que Excel detecte y cargue el complemento de VSTO, y establece la configuración de seguridad en el equipo de desarrollo para permitir la ejecución del complemento de VSTO. Para obtener más información, vea Compilar soluciones de Office.

  2. En Excel, guarde el libro.

  3. Compruebe que el texto siguiente se agrega al libro.

    Este texto se agregó mediante código.

  4. Cierre Excel.

Limpieza del proyecto

Cuando termine de desarrollar un proyecto, quite el ensamblado del complemento de VSTO, las entradas del registro y la configuración de seguridad del equipo de desarrollo. De lo contrario, el complemento de VSTO se ejecutará cada vez que abra Excel en el equipo de desarrollo.

Para limpiar el proyecto completado en el equipo de desarrollo

  1. En el menú Crear de Visual Studio, haga clic en Limpiar solución.

Pasos siguientes

Ahora que ha creado un complemento básico de VSTO para Excel, puede obtener más información sobre cómo desarrollar complementos de VSTO en estos temas:

  • Tareas generales de programación que puede realizar en complementos vsTO: programas de complementos de VSTO.

  • Tareas de programación específicas de complementos de VSTO de Excel: soluciones de Excel.

  • Uso del modelo de objetos de Excel: Información general del modelo de objetos de Excel.

  • Personalización de la interfaz de usuario (UI) de Excel, por ejemplo, agregando una pestaña personalizada a la cinta de opciones o creando su propio panel de tareas personalizado: personalización de la interfaz de usuario de Office.

  • Compilar y depurar complementos de VSTO para Excel: compilar soluciones de Office.

  • Implementar complementos de VSTO para Excel: implementar una solución de Office.

Contenido relacionado