Tutorial: Crear la primera personalización en el nivel del documento para Excel

Artículo
08/10/2011

Este tutorial preliminar muestra cómo crear una personalización en el nivel del documento para Microsoft Office Excel. Las características que se crean en este tipo de solución solo están disponibles cuando está abierto un libro concreto. No puede utilizar una personalización en el nivel del documento para hacer modificaciones en el nivel de la aplicación, por ejemplo, mostrar una nueva ficha de la cinta de opciones al abrir el libro.

Se aplica a: la información de este tema se aplica a los proyectos de nivel de documento 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 libro de Excel.
Agregar texto a la hoja hospedada en el diseñador de Visual Studio.
Escribir código que utiliza el modelo de objetos de Excel para agregar texto al libro cuando se abre.
Generar y ejecutar el proyecto para probarlo.
Limpiar el proyecto completado para quitar archivos de compilación innecesarios y la configuración de seguridad del 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 libro 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 Libro de Excel 2007 o Libro de Excel 2010.
En el cuadro Nombre, escriba FirstWorkbookCustomization.
Haga clic en Aceptar.

Se abre el Asistente para proyectos de Visual Studio Tools para Office.
Seleccione Crear un nuevo documento y haga clic en Aceptar.
- Visual Studio crea el proyecto FirstWorkbookCustomization y le agrega los archivos siguientes.
- FirstWorkbookCustomization.xlsx - Representa el libro de Excel en el proyecto. Contiene todas las hojas de cálculo y gráficos.
- Sheet1 (archivo .vb para Visual Basic o archivo .cs para Visual C#): una hoja de cálculo que proporciona la superficie de diseño y el código para la primera hoja de cálculo del libro. Para obtener más información, vea Elemento host Worksheet.
- Sheet2 (archivo .vb para Visual Basic o archivo .cs para Visual C#): una hoja de cálculo que proporciona la superficie de diseño y el código para la segunda hoja de cálculo del libro.
- Sheet3 (archivo .vb para Visual Basic o archivo .cs para Visual C#): una hoja de cálculo que proporciona la superficie de diseño y el código para la tercera hoja de cálculo del libro.
- ThisWorkbook (archivo .vb para Visual Basic o archivo .cs para Visual C#): contiene la superficie de diseño y el código para las personalizaciones de libros. Para obtener más información, vea Elemento host Workbook.
El archivo de código Sheet1 se abre automáticamente en el diseñador.

Cerrar y volver a abrir hojas de cálculo en el diseñador

Si cierra deliberada o accidentalmente un libro o una hoja de cálculo en el diseñador mientras está desarrollando el proyecto, puede volver a abrirlo.

Para cerrar y volver a abrir una hoja de cálculo en el diseñador

Cierre el libro haciendo clic en el botón Cerrar (X) de la ventana del diseñador.
En el Explorador de soluciones, haga clic con el botón secundario en el archivo de código Sheet1 y seleccione Ver diseñador.

O bien

En el Explorador de soluciones, haga doble clic en el archivo de código Sheet1.

Agregar texto a una hoja de cálculo en el diseñador

Puede diseñar la interfaz de usuario de la personalización modificando la hoja de cálculo que está abierta en el diseñador. Por ejemplo, puede agregar texto a las celdas, aplicar fórmulas o agregar controles de Excel. Para obtener más información sobre cómo usar el diseñador, vea Proyectos de Office en el entorno de Visual Studio.

Para agregar texto a la hoja de cálculo utilizando el diseñador

En la hoja de cálculo abierta en el diseñador, seleccione la celda A1 y, a continuación, escriba el texto siguiente.

Este texto se agregó usando el diseñador.

Precaución
Si agrega esta línea de texto a la celda A2, se sobrescribirá con otro código de este ejemplo.

Agregar texto a una hoja de cálculo mediante programación

Agregue código al archivo de código Sheet1. El nuevo código utiliza el modelo de objetos de Excel para agregar una segunda línea de texto al libro. De forma predeterminada, el archivo de código Sheet1 contiene el código generado siguiente:

Una definición parcial de la clase Sheet1, que representa el modelo de programación de la hoja de cálculo y proporciona acceso al modelo de objetos de Excel. Para obtener más información, vea Elemento host Worksheet y Información general acerca del modelo de objetos de Word. El resto de la clase Sheet1 se define en un archivo de código oculto que no debe modificar.
Los controladores de eventos Sheet1_Shutdown y Sheet1_Startup. Se llama a estos controladores de eventos cuando Excel carga y descarga la personalización. Utilice estos controladores de eventos para inicializar la personalización cuando se carga y para limpiar los recursos que utiliza la personalización cuando se descarga. Para obtener más información, vea Eventos de los proyectos de Office.

Para agregar una segunda línea de texto a la hoja de cálculo mediante código

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

El archivo de código se abre en Visual Studio.

Reemplace el controlador de evento Sheet1_Startup con el código siguiente. Cuando se abre Sheet1, este código agrega una segunda línea de texto a la hoja de cálculo.

Private Sub Sheet1_Startup(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Startup
    Dim nr As Microsoft.Office.Tools.Excel.NamedRange = _
        Me.Controls.AddNamedRange(Me.Range("A2"), "NamedRange1")
    nr.Value2 = "This text was added by using code"
End Sub

private void Sheet1_Startup(object sender, System.EventArgs e)
{
    Microsoft.Office.Tools.Excel.NamedRange nr =
        this.Controls.AddNamedRange(this.Range["A2", missing], "NamedRange1");
    nr.Value2 = "This text was added by using code";
}

Probar el proyecto

Para probar el libro

Presione F5 para generar y ejecutar el proyecto.

Al generar el proyecto, el código se genera en un ensamblado asociado a la hoja de cálculo. Visual Studio coloca una copia de la hoja de cálculo y el ensamblado en la carpeta de resultados de compilación del proyecto y establece la configuración de seguridad en el equipo de desarrollo para permitir que se ejecute la personalización. Para obtener más información, vea Información general acerca del proceso de compilación de soluciones de Office.
En la hoja de cálculo, compruebe que ve el texto siguiente.

Este texto se agregó usando el diseñador.

Este texto se agregó mediante código.
Cierre el libro.

Limpiar el proyecto

Cuando haya terminado de desarrollar un proyecto, debe quitar los archivos de la carpeta de resultados de compilación y la configuración de seguridad creada por el proceso de compilación.

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 una personalización en el nivel del documento básico para Excel, puede obtener más información sobre la programación de personalizaciones en estos temas:

Tareas de programación generales que puede realizar en personalizaciones en el nivel del documento: Programar personalizaciones de nivel de documento.
Tareas de programación específicas de las personalizaciones de nivel de documento para 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 su propio panel de acciones: Personalización de la interfaz de usuario de Office.
Utilizar los objetos de Excel extendidos que se proporcionan en las herramientas de desarrollo de Office en Visual Studio para realizar tareas que no se pueden llevar a cabo mediante el modelo de objetos de Excel (por ejemplo, hospedar controles administrados en documentos y enlazar controles de Excel a datos mediante el modelo de enlace de datos de Windows Forms): Automatizar Excel usando objetos extendidos.
Generar y depurar personalizaciones en el nivel del documento para Excel: Generar y depurar soluciones de Office.
Implementar personalizaciones en el nivel del documento para Excel: Implementar soluciones de Office.