Comparteix a través de


Tutorial: Creación del primer complemento vsTO para Outlook

Este tutorial muestra cómo crear un complemento de VSTO para Microsoft Office Outlook. Las características que cree en este tipo de solución estarán disponibles para la propia aplicación, con independencia del elemento de Outlook que se abra. Para obtener más información, consulte Introducción al desarrollo de soluciones de Office (VSTO).

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

  • Escribir código que use el modelo de objetos de Outlook para agregar texto al asunto y al cuerpo de un nuevo mensaje de correo.

  • 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 Outlook 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, elija un proyecto de complemento VSTO de Outlook.

  6. En el cuadro Nombre , escriba FirstOutlookAddIn.

  7. Haga clic en OK.

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

Escribir código que agrega texto a cada nuevo mensaje de correo

A continuación, agregue código al archivo de código ThisAddIn. El nuevo código usa el modelo de objetos de Outlook para agregar texto a cada nuevo mensaje de correo. 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 Outlook. 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 Outlook carga y descarga el complemento 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 texto al asunto y al cuerpo de cada nuevo mensaje de correo

  1. En el archivo de código ThisAddIn, declare un campo denominado inspectors en la clase ThisAddIn . El campo inspectors mantiene una referencia a la colección de ventanas de Inspector en la instancia actual de Outlook. Esta referencia impide que el recolector de elementos no usados libere la memoria que contiene el controlador de eventos para el evento NewInspector .

    Outlook.Inspectors inspectors;
    
  2. Reemplace el método ThisAddIn_Startup por el código siguiente. Este código asocia un controlador de eventos al evento NewInspector .

    private void ThisAddIn_Startup(object sender, System.EventArgs e)
    {
        inspectors = this.Application.Inspectors;
        inspectors.NewInspector +=
        new Microsoft.Office.Interop.Outlook.InspectorsEvents_NewInspectorEventHandler(Inspectors_NewInspector);
    }
    
  3. En el archivo de código ThisAddIn, agregue el código siguiente a la clase ThisAddIn . Este código define un controlador de eventos para el evento NewInspector .

    Cuando el usuario crea un nuevo mensaje de correo, este controlador de eventos agrega texto a la línea de asunto y al cuerpo del mensaje.

    void Inspectors_NewInspector(Microsoft.Office.Interop.Outlook.Inspector Inspector)
    {
        Outlook.MailItem mailItem = Inspector.CurrentItem as Outlook.MailItem;
        if (mailItem != null)
        {
            if (mailItem.EntryID == null)
            {
                mailItem.Subject = "This text was added by using code";
                mailItem.Body = "This text was added by using code";
            }
    
        }
    }
    

    Para modificar cada nuevo mensaje de correo, 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 Outlook.

  • El parámetro Inspector del controlador de eventos para el evento NewInspector . El parámetro Inspector es un objeto Inspector , que representa la ventana del Inspector del nuevo mensaje de correo. Para obtener más información, vea Soluciones de Outlook.

Prueba del proyecto

Al compilar y ejecutar el proyecto, compruebe que el texto aparece en la línea de asunto y en el cuerpo de un nuevo mensaje de correo.

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 Outlook 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, consulte Introducción al proceso de compilación de soluciones de Office.

  2. En Outlook, cree un nuevo mensaje de correo.

  3. Compruebe que el siguiente texto se agrega a la línea de asunto y al cuerpo del mensaje.

    Este texto se agregó mediante código.

  4. Cierre Outlook.

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 VSTO se ejecutará cada vez que abra Outlook en el equipo de desarrollo.

Para limpiar el proyecto

  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 Outlook, puede obtener más información sobre cómo desarrollar complementos VSTO en estos temas:

  • Tareas de programación generales que puede realizar mediante el uso de complementos VSTO para Outlook. Para obtener más información, consulte Complementos de VSTO de programa.

  • Usar el modelo de objetos de Outlook. Para obtener más información, vea Soluciones de Outlook.

  • Personalizar la interfaz de usuario (UI) de Outlook, por ejemplo, agregando una pestaña personalizada a la cinta o creando su propio panel de tareas personalizado. Para obtener más información, vea Personalización de la interfaz de usuario de Office.

  • Compilar y depurar los complementos de VSTO para Outlook. Para obtener más información, vea Compilar soluciones de Office.

  • Implementar complementos de VSTO para Outlook. Para obtener más información, vea Implementar una solución de Office.