Visão geral dos suplementos do Word

  • Artigo

Você deseja criar uma solução que estenda a funcionalidade do Word? Por exemplo, uma solução que envolva conjuntos de documentos automatizados? Ou uma solução que vincule essas associações aos dados e os acesse em um documento do Word a partir de outras fontes de dados? Você pode usar a plataforma Suplementos do Office, que inclui a API JavaScript Word e a API JavaScript do Office, para estender Word clientes em execução em uma área de trabalho do Windows, em um Mac ou na nuvem.

Os suplementos do Word são uma das muitas opções de desenvolvimento que você tem na plataforma de suplementos do Office. Você pode usar comandos de suplemento para estender a interface do usuário do Word e iniciar os painéis de tarefas que executam JavaScript que interage com o conteúdo em um documento do Word. Qualquer código que você pode executar em um navegador, pode ser executado em um suplemento do Word. Suplementos que interagem com conteúdo em um documento do Word criam solicitações para agir em objetos do Word e sincronizar o estado do objeto.

Observação

Se você planeja publicar o seu suplemento no AppSource e disponibilizá-lo na experiência do Office, certifique-se de que está em conformidade com as políticas de certificação do Marketplace Comercial. Por exemplo, para passar na validação, o suplemento deve funcionar em todas as plataformas com suporte para os métodos definidos (saiba mais na seção 1120.3 e na página de aplicativo e disponibilidade do Suplemento do Office).

A figura a seguir mostra um exemplo de um suplemento do Word que é executado em um painel de tarefas.

Figura 1. Suplemento em execução em um painel de tarefas no Word

Suplemento em execução em um painel de tarefas no Word.

O suplemento Word pode fazer o seguinte:

  1. Envie solicitações para o documento Word.
  2. Use JavaScript para acessar o objeto de parágrafo e atualizar, excluir ou mover o parágrafo.

Por exemplo, o código a seguir mostra como acrescentar uma nova sentença a esse parágrafo.

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();
});

Você pode usar qualquer tecnologia de servidor Web para hospedar o suplemento do Word, como ASP.NET, NodeJS ou Python. Use sua estrutura favorita do lado do cliente -- Ember, Backbone, Angular, React -- ou fique com baunilha ou JavaScript simples para desenvolver sua solução. Você também pode usar serviços como o Azure para autenticar e hospedar seu aplicativo.

As APIs JavaScript do Word proporcionam ao seu aplicativo o acesso aos objetos e metadados encontrado em um documento do Word. Você pode usar essas APIs para criar suplementos que têm como objetivo:

  • Word Online
  • Word 2016 ou posterior no Windows
  • Word no Mac
  • Word no iPad

Redija seu suplemento uma vez e ele será executado em todas as versões do Word em várias plataformas. Para obter detalhes, confira Disponibilidade do aplicativo cliente do Office e da plataforma para suplementos do Office.

APIs JavaScript para Word

Você pode usar dois conjuntos de APIs JavaScript para interagir com metadados e objetos em um documento do Word. O primeiro é a API comuns, que foi introduzido no Office 2013. Muitos dos objetos na API comuns podem ser usados em suplementos hospedados por dois ou mais clientes do Office. Essa API usa retornos de chamadas de maneira ampla.

O segundo é a API JavaScript do Word. Este é um modelo de API específico do aplicativo que foi introduzido com Word 2016. É um modelo de objeto fortemente tipado que você pode usar para criar Word suplementos que visam Word 2016 e posterior no Windows e no Mac. Esse modelo de objeto usa promessas e fornece acesso a objetos específicos de Word, como corpo, controles de conteúdo, imagens embutidas e parágrafos. A API JavaScript do Word inclui definições do TypeScript e arquivos vsdoc para que você possa obter dicas de código em seu IDE.

Atualmente, todos os clientes do Word oferecem suporte à API JavaScript para Office compartilhada, e a maioria dos clientes oferece suporte à API JavaScript do Word. Para obter detalhes sobre os clientes com suporte, confira a Disponibilidade de aplicativos e plataformas do cliente do Office para suplementos do Office.

Recomendamos que você comece com a API JavaScript do Word porque o modelo de objeto é mais fácil de usar. Use o Word API JavaScript se precisar fazer o seguinte:

  • Acessar os objetos em um documento do Word.

Use a API javascript compartilhada do Office quando precisar fazer qualquer um dos seguintes procedimentos:

  • Executar ações iniciais do aplicativo.
  • Verificar o conjunto requisitos com suporte.
  • Acessar metadados, configurações e informações do ambiente para o documento.
  • Vincular a seções em um documento e capturar eventos.
  • Abrir uma caixa de diálogo.

Próximas etapas

Pronto para criar seu primeiro suplemento do Word? Consulte Compilar seu primeiro suplemento do Word. Use o manifesto de suplemento para descrever onde seu suplemento está hospedado, como ele é exibido e definir permissões e outras informações.

Para saber mais sobre como criar um suplemento de Word de classe mundial que cria uma experiência atraente para seus usuários, consulte Diretrizes de design e Melhores práticas.

Depois de desenvolver seu suplemento, é possível publicá-lo em um compartilhamento de rede, um catálogo de aplicativos ou no AppSource.

Confira também