Tutorial: Crear el primer complemento en el nivel de la aplicación para Excel

Artículo
08/10/2011

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

Se aplica a: la información de este tema se aplica a los proyectos de nivel de aplicación para Excel 2007 y Excel 2010. Para obtener más información, vea Características disponibles por aplicación y tipo de proyecto de Office.

En este tutorial se muestran las tareas siguientes:

Crear un proyecto de complemento de Excel.
Escribir código que utiliza el modelo de objetos de Excel para agregar texto a un libro cuando se guarda.
Generar y ejecutar el proyecto para probarlo.
Limpiar el proyecto completado para que el complemento ya no se ejecute automáticamente en el equipo de desarrollo.

Nota

Es posible que su equipo muestre nombres o ubicaciones diferentes para algunos de los elementos de la interfaz de usuario de Visual Studio incluidos en las instrucciones siguientes. 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 Valores de configuración de Visual Studio.

Requisitos previos

Necesita los componentes siguientes para completar este tutorial:

Una edición de Visual Studio 2010 que incluye las herramientas para desarrolladores de Microsoft Office. Para obtener más información, vea [Configurar un equipo para desarrollar soluciones de Office](bb398242\(v=vs.100\).md).

Microsoft Office Excel 2007 o Excel 2010.

Crear el proyecto

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

Inicie Visual Studio.
En el menú Archivo, elija Nuevo y haga clic en Proyecto.
En el recuadro de plantillas, expanda Visual C# o Visual Basic y, a continuación, expanda Office.
Bajo el nodo Office expandido, seleccione 2007 si tiene Excel 2007 instalado o seleccione 2010 si tiene Excel 2010 instalado.
En la lista de plantillas de proyecto, seleccione Complemento de Excel 2007 o Complemento de Excel 2010.
En el cuadro Nombre, escriba FirstExcelAddIn.
Haga clic en Aceptar.

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 que está abierta cuando el usuario guarda el libro. De forma predeterminada, el archivo de código ThisAddIn contiene el código generado siguiente:

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, vea Programar complementos de nivel de aplicación. El resto de la clase ThisAddIn se define en un archivo de código oculto que no debe modificar.
Los controladores de eventos ThisAddIn_Shutdown y ThisAddIn_Startup. Se llama a estos controladores de eventos cuando Excel carga y descarga el complemento. Use estos controladores de eventos para inicializar el complemento cuando éste se cargue y para limpiar los recursos cuando se descargue. Para obtener más información, vea Eventos de los proyectos de Office.

Para agregar una línea de texto al libro guardado

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 provoca cuando se guarda un libro.

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

Private Sub Application_WorkbookBeforeSave(ByVal Wb As Microsoft.Office.Interop.Excel.Workbook, ByVal SaveAsUI As Boolean, ByRef Cancel As Boolean) Handles Application.WorkbookBeforeSave
    Dim activeWorksheet As Excel.Worksheet = CType(Application.ActiveSheet, Excel.Worksheet)
    Dim firstRow As Excel.Range = activeWorksheet.Range("A1")
    firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown)
    Dim newFirstRow As Excel.Range = activeWorksheet.Range("A1")
    newFirstRow.Value2 = "This text was added by using code"
End Sub

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", missing);
    firstRow.EntireRow.Insert(Excel.XlInsertShiftDirection.xlShiftDown, System.Type.Missing);
    Excel.Range newFirstRow = activeWorksheet.get_Range("A1", missing);
    newFirstRow.Value2 = "This text was added by using code";
}

Si utiliza C#, agregue el siguiente código necesario al controlador de eventos ThisAddIn_Startup. Este código se utiliza para conectar el controlador de eventos Application_WorkbookBeforeSave al evento WorkbookBeforeSave.
```
this.Application.WorkbookBeforeSave += new Microsoft.Office.Interop.Excel.AppEvents_WorkbookBeforeSaveEventHandler(Application_WorkbookBeforeSave);
```

Para modificar el libro al guardarlo, los ejemplos de código anteriores utilizan los objetos siguientes:

El campo Application de la clase ThisAddIn. El campo Application devuelve un objeto Microsoft.Office.Interop.Excel.Application, que representa la instancia actual de Excel.
El parámetro Wb del controlador del evento WorkbookBeforeSave. El parámetro Wb es un objeto Microsoft.Office.Interop.Excel.Workbook, que representa el libro guardado. Para obtener más información, vea Información general sobre el modelo de objetos de Excel.

Probar el proyecto

Para probar el proyecto

Presione F5 para generar y ejecutar el proyecto.

Al generar el proyecto, el código se compila en un ensamblado que se incluye en la carpeta de resultado de compilación del proyecto. Visual Studio también crea un conjunto de entradas del Registro que permiten que Excel detecte y cargue el complemento, y establece la configuración de seguridad en el equipo de desarrollo a fin de permitir la ejecución del complemento. Para obtener más información, vea Información general acerca del proceso de compilación de soluciones de Office.
En Excel, guarde el libro.
Compruebe que el texto siguiente se agrega al libro.

Este texto se agregó mediante código.
Cierre Excel.

Limpiar el proyecto

Al terminar de desarrollar un proyecto, quite el ensamblado de complemento, las entradas del Registro y la configuración de seguridad del equipo de desarrollo. De lo contrario, el complemento continuará ejecutándose cada vez que abra Excel en este equipo.

Para limpiar el proyecto completado en el equipo de desarrollo

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

Pasos siguientes

Ahora que ha creado un complemento básico en el nivel de la aplicación para Excel, puede obtener más información sobre la programación de complementos en estos temas:

Tareas de programación generales que puede realizar en los complementos: Programar complementos de nivel de aplicación.
Tareas de programación específicas de los complementos de Excel: Soluciones de Excel.
Utilizar el modelo de objetos de Excel: Información general sobre el modelo de objetos de Excel.
Personalizar la interfaz usuario de Excel, por ejemplo, agregando una ficha personalizada a la cinta de opciones o creando un panel de tareas personalizado: Personalización de la interfaz de usuario de Office.
Generar y depurar los complementos en el nivel de la aplicación para Excel: Generar y depurar soluciones de Office.
Implementar complementos en el nivel de la aplicación para Excel: Implementar soluciones de Office.