Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
WordApi 1.7 adicionou principalmente suporte para assistência de escrita.
Importante
As APIs de anotação exigem uma assinatura do Microsoft 365 para funcionar corretamente devido aos requisitos de um serviço subjacente. Para obter mais informações, consulte GitHub issue 4953.
Lista de APIs
A tabela a seguir lista as APIs no conjunto de requisitos da API JavaScript do Word 1.7. Para exibir a documentação de referência da API para todas as APIs compatíveis com o conjunto de requisitos 1.7 ou anterior da API JavaScript do Word, consulte APIs do Word no conjunto de requisitos 1.7 ou anterior.
| Classe | Campos | Descrição |
|---|---|---|
| Annotation | critiqueAnnotation | Obtém o CritiqueAnnotation objeto. |
| delete() | Exclui a anotação. | |
| id | Obtém o identificador exclusivo, que deve ser usado para facilitar o acompanhamento de Annotation objetos. |
|
| state | Obtém o estado da anotação. | |
| AnnotationClickedEventArgs | id | Especifica a ID de anotação para a qual o evento foi acionado. |
| AnnotationCollection | getFirst() | Obtém a primeira anotação nesta coleção. |
| getFirstOrNullObject() | Obtém a primeira anotação nesta coleção. | |
| items | Obtém os itens filhos carregados nesta coleção. | |
| AnotaçãoHoveredEventArgs | id | Especifica a ID de anotação para a qual o evento foi acionado. |
| AnotaçãoInseridoEventArgs | ids | Especifica as IDs de anotação para as quais o evento foi acionado. |
| AnnotationRemovedEventArgs | ids | Especifica as IDs de anotação para as quais o evento foi acionado. |
| Conjunto de anotações | críticas | Críticas. |
| CheckboxContentControl | isChecked | Especifica o estado atual da caixa de seleção. |
| ContentControl | checkboxContentControl | Obtém os dados do controle de conteúdo quando seu tipo é checkBox. |
| Crítica | colorScheme | Especifica o esquema de cores da crítica. |
| comprimento | Especifica o comprimento da crítica dentro do parágrafo. | |
| start | Especifica o índice inicial da crítica dentro do parágrafo. | |
| CritiqueAnnotation | accept() | Aceita a crítica. |
| crítica | Obtém a crítica que foi aprovada quando a anotação foi inserida. | |
| range | Obtém o intervalo de texto anotado. | |
| reject() | Rejeita a crítica. | |
| Document | getAnnotationById(id: string) | Obtém a anotação por ID. |
| onAnnotationClicked | Ocorre quando o usuário clica em uma anotação (ou a seleciona usando Alt+Down). | |
| onAnnotationHovered | Ocorre quando o usuário passa o cursor sobre uma anotação. | |
| onAnnotationInserted | Ocorre quando o usuário adiciona uma ou mais anotações. | |
| onAnnotationRemoved | Ocorre quando o usuário exclui uma ou mais anotações. | |
| search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) | Executa uma pesquisa com as opções de pesquisa especificadas no escopo do documento inteiro. | |
| GetTextOptions | includeHiddenText | Se fornecido, especifica se deseja incluir texto oculto no resultado do Paragraph.getText método. |
| includeTextMarkedAsDeleted | Se fornecido, especifica se o texto marcado como excluído deve ser incluído no resultado do Paragraph.getText método. |
|
| InsertFileOptions | importDifferentOddEvenPages | Se fornecido, especifica se deseja importar a configuração de Páginas Pares e Ímpares Diferentes para o cabeçalho e o rodapé do documento de origem. |
| Paragraph | getAnnotations() | Obtém anotações definidas neste Paragraph objeto. |
| getText(options?: Word. GetTextOptions | { IncludeHiddenText?: boolean IncludeTextMarkedAsDeleted?: boolean }) | Retorna o texto do parágrafo. | |
| insertAnnotations(anotações: Word. Conjunto de Anotações) | Insere anotações neste Paragraph objeto. |