Compartir a través de

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

  • Artículo

Este tutorial introductorio muestra cómo crear un complemento de VSTO para Microsoft Office Word. Las características que cree en este tipo de solución estarán disponibles para la propia aplicación, con independencia de los documentos que estén abiertos.

Se aplica a: La información de este tema se aplica a los proyectos de complementos de VSTO 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 complemento de VSTO de Word.

  • Escribir código que usa el modelo de objetos de Word para agregar texto a un documento 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 de Word 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 un proyecto de complemento de VSTO de Word.

  6. En el cuadro Nombre , escriba FirstWordAddIn.

  7. Haga clic en OK.

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

Escribir código para agregar texto al documento guardado

A continuación, agregue código al archivo de código ThisAddIn. El nuevo código usa el modelo de objetos de Word para agregar texto reutilizable a cada documento guardado. 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 Word. 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 Word 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 de VSTO cuando se descargue. Para obtener más información, vea Eventos en proyectos de Office.

Para agregar un párrafo de texto al documento 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 DocumentBeforeSave, que se desencadena cuando se guarda un documento.

    Cuando el usuario guarda un documento, el controlador de eventos agrega el nuevo texto al principio del documento.

    void Application_DocumentBeforeSave(Word.Document Doc, ref bool SaveAsUI, ref bool Cancel)
{
    Doc.Paragraphs[1].Range.InsertParagraphBefore();
    Doc.Paragraphs[1].Range.Text = "This text was added by using code.";
}

    Nota:

    Este código usa un valor de índice 1 para acceder al primer párrafo de la colección 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.

  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_DocumentBeforeSave con el evento DocumentBeforeSave .

    this.Application.DocumentBeforeSave += 
    new Word.ApplicationEvents4_DocumentBeforeSaveEventHandler(Application_DocumentBeforeSave);

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

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

  • El parámetro Doc del controlador de eventos para el evento DocumentBeforeSave . El parámetro Doc es un objeto Document que representa el documento guardado. Para obtener más información, consulte Introducción al modelo de objetos de Word.

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 Word 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 Word, guarde el documento activo.

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

    Este texto se agregó mediante código.

  4. Cierre Word.

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 Word 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 ya creó creado un complemento básico de VSTO para Word, 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 vsTO de Word: soluciones de 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 tareas personalizado: personalización de la interfaz de usuario de Office.

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

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

Contenido relacionado