Visão geral dos suplementos do Word
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? Pode utilizar a plataforma Suplementos do Office, que inclui o Word API JavaScript e a API JavaScript do Office, para expandir Word clientes em execução na Web, num ambiente de trabalho do Windows ou num Mac.
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.
O suplemento Word pode fazer o seguinte:
- Enviar pedidos para o documento Word.
- Utilize JavaScript para aceder ao objeto de parágrafo e atualizar, eliminar ou mover o parágrafo.
Por exemplo, o código seguinte mostra como acrescentar uma nova frase ao primeiro parágrafo selecionado.
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. Utilize a sua arquitetura favorita do lado do cliente ( Ember, Backbone, Angular, React) ou mantenha-se com JavaScript simples para desenvolver a sua solução. Também pode utilizar serviços como o Azure para autenticar e alojar a sua aplicação.
As APIs JavaScript do Word proporcionam ao seu aplicativo o acesso aos objetos e metadados encontrado em um documento do Word. Pode utilizar estas APIs para criar suplementos que visam os seguintes clientes.
- Word Online
- Word 2016 ou posterior no Windows
- Word no Mac
- Word no iPad
Escreva o suplemento uma vez e será executado em todas as versões suportadas do Word em várias plataformas. Para obter detalhes, consulte Disponibilidade da plataforma e da aplicação cliente do Office 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 da aplicação que foi introduzido com Word 2016. É um modelo de objetos de tipo forte que pode utilizar para criar Word suplementos que visam Word 2016 e posteriores no Windows e no Mac. Este modelo de objeto utiliza promessas e fornece acesso a objetos específicos de Word, como corpo, controlos de conteúdo, imagens inline 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. Utilize o Word API JavaScript se precisar de aceder aos objetos num documento Word.
Utilize a API de JavaScript do Office partilhada quando precisar de efetuar um dos seguintes procedimentos:
- Executar ações de inicialização para a aplicação.
- 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. Utilize o manifesto do suplemento para descrever onde o suplemento está alojado, como é apresentado 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 apelativa para os seus utilizadores, 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.