APIs de pré-visualização de JavaScript do Word
Os novos Word APIs JavaScript são introduzidos pela primeira vez em "pré-visualização" e, mais tarde, tornam-se parte de um conjunto de requisitos numerado específico após o teste suficiente e o feedback do utilizador é adquirido.
Importante
Tenha em atenção que as seguintes APIs de pré-visualização Word podem estar disponíveis nas seguintes plataformas.
- Word no Windows
- Word no Mac
Word APIs de pré-visualização não são atualmente suportadas no iPad. No entanto, várias APIs também podem estar disponíveis no Word na Web. Para APIs disponíveis apenas em Word na Web, veja a lista de API apenas na Web.
Observação
As APIs de visualização estão sujeitas a alterações e não se destinam ao uso em um ambiente de produção. Recomendamos que você experimente apenas em ambiente de teste e desenvolvimento. Não use APIs de visualização em um ambiente de produção ou em documentos essenciais aos negócios.
Para usar APIs de visualização:
- Tem de utilizar a versão de pré-visualização da biblioteca de API javaScript do Office a partir da rede de entrega de conteúdos (CDN)Office.js. O arquivo de definição de tipo da compilação TypeScript e IntelliSense pode ser encontrado na CDN e DefinitelyTyped. Pode instalar estes tipos com
npm install --save-dev @types/office-js-preview(certifique-se de que remove os tipos para@types/office-jsse os tiver instalado anteriormente). - Poderá ter de aderir ao programa Microsoft 365 Insider para aceder a compilações mais recentes do Office.
Lista de API
A tabela seguinte lista as APIs JavaScript Word atualmente em pré-visualização, exceto as que estão disponíveis apenas no Word na Web. Para ver uma lista completa de todas as APIs JavaScript Word (incluindo APIs de pré-visualização e APIs lançadas anteriormente), veja todas as APIs javaScript Word.
| Classe | Campos | Descrição |
|---|---|---|
| Body | insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "Texto Simples" | "Caixa de Verificação" | "DropDownList" | "Caixa de Combinação") | Molda o objeto Corpo com um controlo de conteúdo. |
| ComboBoxContentControl | addListItem(displayText: cadeia, valor?: cadeia, índice?: número) | Adiciona um novo item de lista a este controlo de conteúdo de caixa de combinação e devolve um Word. Objeto ContentControlListItem. |
| deleteAllListItems() | Elimina todos os itens de lista neste controlo de conteúdo da caixa de combinação. | |
| listItems | Obtém a coleção de itens de lista no controlo de conteúdo da caixa de combinação. | |
| ContentControl | comboBoxContentControl | Especifica os dados relacionados com a caixa de combinação se o tipo do controlo de conteúdo for "Caixa de Combinação". |
| dropDownListContentControl | Especifica os dados relacionados com a lista pendente se o tipo do controlo de conteúdo for "DropDownList". | |
| resetState() | Repõe o estado do controlo de conteúdo. | |
| setState(contentControlState: Word. ContentControlState) | Define o estado do controlo de conteúdo. | |
| ContentControlListItem | delete() | Exclui o item de lista. |
| displayText | Especifica o texto a apresentar de um item de lista para uma lista pendente ou controlo de conteúdo de caixa de combinação. | |
| índice | Especifica a localização do índice de um item de lista de controlo de conteúdo na coleção de itens de lista. | |
| Seleciona. | Seleciona o item de lista e define o texto do controlo de conteúdo para o valor do item de lista. | |
| value | Especifica o valor programático de um item de lista para uma lista pendente ou controlo de conteúdo de caixa de combinação. | |
| ContentControlListItemCollection | getFirst() | Obtém o primeiro item de lista nesta coleção. |
| getFirstOrNullObject() | Obtém o primeiro item de lista nesta coleção. | |
| items | Obtém os itens filhos carregados nesta coleção. | |
| Document | compareFromBase64(base64File: cadeia, documentCompareOptions?: Word. DocumentCompareOptions) | Exibe marcas de revisão que indicam onde o documento especificado difere de um outro documento. |
| DropDownListContentControl | addListItem(displayText: cadeia, valor?: cadeia, índice?: número) | Adiciona um novo item de lista a este controlo de conteúdo de lista pendente e devolve um Word. Objeto ContentControlListItem. |
| deleteAllListItems() | Elimina todos os itens de lista neste controlo de conteúdo de lista pendente. | |
| listItems | Obtém a coleção de itens de lista no controlo de conteúdo da lista pendente. | |
| Font | hidden | Especifica um valor que indica se o tipo de letra está marcado como oculto. |
| Paragraph | insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "Texto Simples" | "Caixa de Verificação" | "DropDownList" | "Caixa de Combinação") | Molda o objeto Parágrafo com um controlo de conteúdo. |
| Range | insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "Texto Simples" | "Caixa de Verificação" | "DropDownList" | "Caixa de Combinação") | Molda o objeto Intervalo com um controlo de conteúdo. |
| Estilo | description | Obtém a descrição do estilo especificado. |
Lista de API apenas na Web
A tabela seguinte lista as APIs javaScript Word atualmente em pré-visualização apenas em Word na Web. Para ver uma lista completa de todas as APIs JavaScript Word (incluindo APIs de pré-visualização e APIs lançadas anteriormente), veja todas as APIs javaScript Word.
| Classe | Campos | Descrição |
|---|---|---|
| Body | onCommentAdded | Ocorre quando são adicionados novos comentários. |
| onCommentChanged | Ocorre quando um comentário ou a respetiva resposta é alterada. | |
| onCommentDeleted | Ocorre quando os comentários são eliminados. | |
| onCommentDeselected | Ocorre quando um comentário é desselecionado. | |
| onCommentSelected | Ocorre quando um comentário é selecionado. | |
| CommentDetail | id | Representa o ID deste comentário. |
| replyIds | Representa os IDs das respostas a este comentário. | |
| CommentEventArgs | changeType | Representa a forma como o evento alterado do comentário é acionado. |
| commentDetails | Obtém a matriz CommentDetail que contém os IDs e os IDs de resposta dos comentários envolvidos. | |
| source | A origem do evento. | |
| type | O tipo de evento. | |
| ContentControl | onCommentAdded | Ocorre quando são adicionados novos comentários. |
| onCommentChanged | Ocorre quando um comentário ou a respetiva resposta é alterada. | |
| onCommentDeselected | Ocorre quando um comentário é desselecionado. | |
| onCommentSelected | Ocorre quando um comentário é selecionado. | |
| Paragraph | onCommentAdded | Ocorre quando são adicionados novos comentários. |
| onCommentChanged | Ocorre quando um comentário ou a respetiva resposta é alterada. | |
| onCommentDeleted | Ocorre quando os comentários são eliminados. | |
| onCommentDeselected | Ocorre quando um comentário é desselecionado. | |
| onCommentSelected | Ocorre quando um comentário é selecionado. | |
| Range | onCommentAdded | Ocorre quando são adicionados novos comentários. |
| onCommentChanged | Ocorre quando um comentário ou a respetiva resposta é alterada. | |
| onCommentDeselected | Ocorre quando um comentário é desselecionado. | |
| onCommentSelected | Ocorre quando um comentário é selecionado. |
Confira também
Colaborar conosco no GitHub
A fonte deste conteúdo pode ser encontrada no GitHub, onde você também pode criar e revisar problemas e solicitações de pull. Para obter mais informações, confira o nosso guia para colaboradores.