Compartir a través de

Tutorial: Crear la primera personalización de nivel de documento para Word

  • Artículo

En este tutorial introductorio se muestra cómo crear una personalización de nivel de documento para Microsoft Office Word. Las características que se crean en este tipo de solución solo están disponibles cuando se abre un documento concreto. No puede usar una personalización de nivel de documento para efectuar cambios en toda la aplicación, por ejemplo, para mostrar una nueva pestaña de la cinta de opciones cuando se abre un documento.

Se aplica a: la información de este tema se aplica a proyectos de nivel de documento para Word. Para obtener más información, consulte Características disponibles por aplicación de Office lication y tipo de proyecto.

En este tutorial se muestran las tareas siguientes:

  • Crear un proyecto de documento de Word.

  • Agregar texto al documento hospedado en el diseñador de Visual Studio.

  • Escribir código que usa el modelo de objetos de Word para agregar texto al documento personalizado cuando se abre.

  • Compilar y ejecutar el proyecto para probarlo.

  • Limpiar el proyecto para quitar los archivos de compilación innecesarios y la configuración de seguridad del 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 documento de Word en Visual Studio

  1. Inicie Visual Studio.

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

  3. En el cuadro de diálogo Crear un nuevo proyecto , seleccione el proyecto documento VSTO de Word.

    Nota:

    También puede buscar plantillas escribiendo el nombre del producto de Office en el cuadro de texto Buscar en la parte superior del cuadro de diálogo Crear un nuevo proyecto . Por ejemplo, al escribir Excel se mostrarán todas las plantillas de proyecto para Excel. También puede filtrar la lista de plantillas para mostrar solo las plantillas de Office seleccionando Office en el cuadro desplegable Tipo de proyecto. Para obtener más información, vea Crear un nuevo proyecto en Visual Studio.

  4. Haga clic en Next.

  5. Escriba FirstWorkbookCustomization en el cuadro Nombre del cuadro de diálogo Configurar el nuevo proyecto y haga clic en Crear.

  6. Seleccione Crear un nuevo documento en el Asistente para proyectos de Visual Studio Tools para Office y haga clic en Aceptar.

    • Visual Studio crea el proyecto FirstDocumentCustomization y agrega el documento FirstDocumentCustomization y el archivo de código ThisDocument al proyecto. El documento FirstDocumentCustomization se abre automáticamente en el diseñador.

Cierre y vuelva a abrir el documento en el diseñador

Puede volver a abrir el documento si lo cierra deliberada o accidentalmente en el diseñador mientras está desarrollando el proyecto.

Para cerrar y volver a abrir el documento en el diseñador

  1. Cierre el documento haciendo clic en el botón Cerrar (X) de la ventana del diseñador.

  2. En Explorador de soluciones, haga clic con el botón derecho en el archivo de código ThisDocument y haga clic en Diseñador de vistas.

    - o -

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

Agregar texto al documento en el diseñador

Puede diseñar la interfaz de usuario de la personalización modificando el documento que está abierto en el diseñador. Por ejemplo, puede agregar texto, tablas o controles de Word. 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 al documento mediante el diseñador

  1. En el documento que está abierto en el diseñador, escriba el siguiente texto.

    Este texto se agregó mediante el diseñador.

Agregar texto al documento mediante programación

Luego, agregue código al archivo de código ThisDocument. El nuevo código usa el modelo de objetos de Word para agregar un segundo párrafo de texto al documento. De forma predeterminada, el archivo de código ThisDocument contiene el siguiente código generado:

  • Una definición parcial de la clase ThisDocument, que representa el modelo de programación del documento y proporciona acceso al modelo de objetos de Word. Para obtener más información, vea Información general sobre el elemento host del documento y el modelo de objetos de Word. El resto de la clase ThisDocument se define en un archivo de código oculto que no se debe modificar.

  • Los controladores de eventos ThisDocument_Startup y ThisDocument_Shutdown . Se llama a estos controladores de eventos cuando se abre y se cierra el documento. Use estos controladores de eventos para inicializar la personalización cuando se abre el documento y para limpiar los recursos que usa la personalización cuando se cierra el documento. Para obtener más información, vea Eventos en proyectos de Office.

Para agregar un segundo párrafo de texto al documento mediante código

  1. En Explorador de soluciones, haga clic con el botón derecho en ThisDocumenty, a continuación, haga clic en Ver código.

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

  2. Reemplace el controlador de eventos ThisDocument_Startup por el siguiente código: Cuando se abre el documento, este código agrega un segundo párrafo de texto al documento.

    private void ThisDocument_Startup(object sender, System.EventArgs e)
{
    this.Paragraphs[1].Range.InsertParagraphAfter();
    this.Paragraphs[2].Range.Text = "This text was added by using code.";
}

    Nota:

    Este código usa el valor de índice 1 para tener acceso al primer párrafo de la propiedad Paragraphs. Aunque Visual Basic y Visual C# usan matrices basadas en 0, el límite de matriz inferior de la mayoría de las colecciones del modelo de objetos de Word es 1. Para obtener más información, vea Escribir código en soluciones de Office.

Prueba del proyecto

Para probar el documento

  1. Presione F5 para compilar y ejecutar el proyecto.

    Al compilar el proyecto, el código se compila en un ensamblado que está asociado al documento. Visual Studio coloca una copia del documento 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 Compilar soluciones de Office.

  2. En el documento, compruebe que ve el texto siguiente.

    Este texto se agregó mediante el diseñador.

    Este texto se agregó mediante código.

  3. Cierre el documento.

Limpieza del proyecto

Cuando termine 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

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

Pasos siguientes

Ahora que ha creado una personalización de nivel de documento básico para Word, en los siguientes temas obtendrá más información sobre cómo desarrollar personalizaciones:

  • Tareas de programación generales que puede realizar en personalizaciones de nivel de documento: personalizaciones de nivel de documento del programa.

  • Tareas de programación específicas de personalizaciones de nivel de documento para las soluciones de Word: Word.

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

  • Personalización de la interfaz de usuario de Word, por ejemplo, agregando una pestaña personalizada a la cinta de opciones o creando su propio panel de acciones: personalización de la interfaz de usuario de Office.

  • Uso de objetos extendidos de Word proporcionados por soluciones de Office en Visual Studio para realizar tareas que no son posibles mediante el modelo de objetos de Word (por ejemplo, hospedar controles administrados en documentos y enlazar controles de Word a datos mediante el modelo de enlace de datos de Windows Forms): Automatice Word mediante objetos extendidos.

  • Creación y depuración de personalizaciones de nivel de documento para Word: Compilar soluciones de Office.

  • Implementar personalizaciones de nivel de documento para Word: implementar una solución de Office.

Contenido relacionado