Información general sobre los complementos de Word

  • Artículo

¿Desea crear una solución que amplíe la funcionalidad de Word? Por ejemplo, ¿uno que implica el ensamblado de documentos automatizado? ¿O bien una solución que enlaza y accede a los datos de un documento de Word desde otros orígenes de datos? Puede usar la plataforma complementos de Office, que incluye la API de JavaScript Word y la API de JavaScript de Office, para ampliar Word clientes que se ejecutan en un escritorio de Windows, en un Equipo Mac o en la nube.

Los complementos de Word son una de las muchas opciones de desarrollo que tiene en la plataforma de complementos de Office. Puede usar los comandos de complemento para ampliar la interfaz de usuario de Word e iniciar paneles de tareas que ejecuten código JavaScript que interactúe con el contenido de un documento de Word. Cualquier código que pueda ejecutar en un explorador también se puede ejecutar en un complemento de Word. Los complementos que interactúan con contenido en un documento de Word crean solicitudes para actuar en objetos de Word y sincronizar el estado de los objetos.

Nota:

Si tiene previsto publicar el complemento para AppSource y hacer que esté disponible en la experiencia de Office, asegúrese de que cumple con las Directivas comerciales de certificación de mercado. Por ejemplo, para superar la validación, el complemento debe funcionar en todas las plataformas que sean compatibles con los métodos especificados (para más información, vea la sección 1120.3 y la página de disponibilidad y aplicación del complemento de Office).

En la ilustración siguiente se muestra un ejemplo de un complemento de Word que se ejecuta en un panel de tareas.

Figura 1. Complemento que se ejecuta en un panel de tareas de Word

Complemento que se ejecuta en un panel de tareas en Word.

El complemento Word puede hacer lo siguiente:

  1. Enviar solicitudes al documento de Word.
  2. Use JavaScript para acceder al objeto de párrafo y actualizar, eliminar o mover el párrafo.

Por ejemplo, en el código siguiente se muestra cómo anexar una nueva frase al párrafo.

await Word.run(async (context) => {
    const paragraphs = context.document.getSelection().paragraphs;
    paragraphs.load();
    await context.sync();
    paragraphs.items[0].insertText(' New sentence in the paragraph.',
                                       Word.InsertLocation.end);
    await context.sync();
});

Puede usar cualquier tecnología de servidor web para hospedar el complemento de Word, como ASP.NET, NodeJS o Python. Use su marco de trabajo del lado cliente favorito (Ember, Backbone, Angular, React) o siga con JavaScript de vainilla o sin formato para desarrollar la solución. También puede usar servicios como Azure para autenticar y hospedar la aplicación.

Las API de JavaScript para Word permiten que su aplicación tenga acceso a los objetos y metadatos de un documento de Word. Puede usar estas API para crear complementos para:

  • Word en la web
  • Word 2016 o posterior en Windows
  • Word en Mac
  • Word en iPad

Escriba su complemento una vez y se ejecutará en todas las versiones de Word en varias plataformas. Para obtener más información, vea Disponibilidad de la plataforma y la aplicación cliente de Office para complementos de Office.

API de JavaScript para Word

Puede usar dos API de JavaScript para interactuar con los objetos y los metadatos en un documento de Word. La primera es la API común, que se introdujo en Office 2013. Muchos de los objetos en la API común se pueden usar en complementos hospedados por dos o más clientes de Office. Esta API usa un gran número de devoluciones de llamada.

La segunda es la API de JavaScript para Word. Se trata de un modelo de API específico de la aplicación que se introdujo con Word 2016. Es un modelo de objetos fuertemente tipado que puede usar para crear complementos de Word que tengan como destino Word 2016 y versiones posteriores en Windows y en Mac. Este modelo de objetos usa promesas y proporciona acceso a objetos específicos de Word, como el cuerpo, los controles de contenido, las imágenes insertadas y los párrafos. La API de JavaScript para Word incluye definiciones TypeScript y archivos vsdoc para que pueda recibir sugerencias de código en su IDE.

Actualmente, todos los clientes de Word son compatibles con la API de JavaScript para Office compartida y la mayoría de los clientes son compatibles con la API de JavaScript para Word. Para más información sobre los clientes compatibles, consulte Disponibilidad de plataforma y aplicaciones cliente de Office para complementos de Office.

Le recomendamos que empiece con la API de JavaScript para Word, ya que le modelo de objetos es más fácil de usar. Use la API de JavaScript Word si necesita hacer lo siguiente:

  • Tener acceso a objetos en un documento de Word.

Use la API de JavaScript de Office compartida cuando necesite realizar cualquiera de las siguientes acciones:

  • Realizar acciones iniciales para la aplicación.
  • Comprobar el conjunto de requisitos admitidos.
  • Tener acceso a metadatos, configuración e información del entorno del documento.
  • Enlazar a secciones de un documento y capturar eventos.
  • Abrir un cuadro de diálogo.

Pasos siguientes

¿Está preparado para crear su primer complemento de Word? Vea Crear el primer complemento de Word. Use el manifiesto del complemento para describir dónde se hospeda el complemento, cómo se muestra y definir permisos y otra información.

Para obtener más información sobre cómo diseñar un complemento Word de primera clase que crea una experiencia atractiva para los usuarios, consulte Directrices de diseño y procedimientos recomendados.

Después de desarrollar el complemento, puede publicarlo en un recurso compartido de red, en un catálogo de aplicaciones o en AppSource.

Recursos adicionales