Compartilhar via

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 só podem estar disponíveis no Word 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:

Lista de API

A tabela seguinte lista as APIs javaScript Word atualmente em pré-visualização. 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.
type Obtém o tipo do corpo.
BookmarkCollection add(name: string, range: Word. Intervalo) Devolve um Bookmark objeto que representa um marcador adicionado a um intervalo.
getItem(index: number) Obtém um Bookmark objeto pelo respetivo índice na coleção.
BorderUniversalCollection getItem(index: number) Obtém um Border objeto pelo respetivo índice na coleção.
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 commentChanged evento é gerado.
commentDetails Obtém a CommentDetail matriz que contém os IDs e os IDs de resposta dos comentários envolvidos.
source Especifica a origem do evento.
type Especifica o tipo de evento.
ConflictCollection getItem(index: number) Obtém um Conflict objeto pelo respetivo índice na coleção.
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.
resetState() Repõe o estado do controlo de conteúdo.
setState(contentControlState: Word. ContentControlState) Define o estado do controlo de conteúdo.
CustomXmlAddValidationErrorOptions clearedOnUpdate Se for fornecido, especifica se o erro deve ser limpo do Word. CustomXmlValidationErrorCollection quando o XML é corrigido e atualizado.
errorText Se for fornecido, especifica o texto de erro descritivo.
CustomXmlNodeCollection getItem(index: number) Devolve um CustomXmlNode objeto que representa o item especificado na coleção.
CustomXmlPart errors Obtém um CustomXmlValidationErrorCollection objeto que fornece acesso a quaisquer erros de validação XML.
CustomXmlPrefixMappingCollection getItem(index: number) Devolve um CustomXmlPrefixMapping objeto que representa o item especificado na coleção.
CustomXmlValidationError delete() Elimina este CustomXmlValidationError objeto.
errorCode Obtém um número inteiro que representa o erro de validação no CustomXmlValidationError objeto.
name Obtém o nome do erro no CustomXmlValidationError objeto.
nó Obtém o nó associado a este CustomXmlValidationError objeto, se existir algum.
text Obtém o texto no CustomXmlValidationError objeto.
type Obtém o tipo de erro gerado a CustomXmlValidationError partir do objeto.
CustomXmlValidationErrorCollection add(node: Word. CustomXmlNode, errorName: cadeia, opções?: Word. CustomXmlAddValidationErrorOptions) Adiciona um CustomXmlValidationError objeto que contém um erro de validação XML ao CustomXmlValidationErrorCollection objeto.
getCount() Devolve o número de itens na coleção.
getItem(index: number) Devolve um CustomXmlValidationError objeto que representa o item especificado na coleção.
items Obtém os itens filhos carregados nesta coleção.
Document checkIn(options?: Word. DocumentCheckInOptions) Verifica o documento do computador local para um servidor e define o documento local como só de leitura para que não possa ser editado localmente.
checkInWithVersion(opções?: Word. DocumentCheckInWithVersionOptions) Guarda o documento num servidor a partir de um computador local e define o documento local como só de leitura para que não possa ser editado localmente.
checkSpelling(options?: Word. DocumentCheckSpellingOptions) Inicia uma marcar ortográfica para o documento.
computeStatistics(estatística: Word. StatisticType, includeFootnotesAndEndnotes?: booleano) Devolve uma estatística com base no conteúdo do documento.
countNumberedItems(opções?: Word. DocumentCountNumberedItemsOptions) Devolve o número de itens com marcas ou numerados e campos LISTNUM no documento.
endReview(options?: Word. DocumentEndReviewOptions) Termina uma revisão do ficheiro que foi enviado para revisão.
exportAsFixedFormat(outputFileName: string, exportFormat: Word. ExportFormat, options?: Word. DocumentExportAsFixedFormatOptions) Guarda o documento no formato PDF ou XPS.
exportAsFixedFormat2(outputFileName: string, exportFormat: Word. ExportFormat, options?: Word. DocumentExportAsFixedFormat2Options) Guarda o documento no formato PDF ou XPS.
exportAsFixedFormat3(outputFileName: string, exportFormat: Word. ExportFormat, options?: Word. DocumentExportAsFixedFormat3Options) Guarda o documento no formato PDF ou XPS com etiquetas melhoradas.
followHyperlink(options?: Word. DocumentFollowHyperlinkOptions) Exibe um documento armazenado em cache, se este já tiver sido baixado.
getRange(opções?: Word. DocumentRangeOptions) Devolve um Range objeto utilizando as posições de carateres iniciais e finais especificadas.
goTo(options?: Word. GoToOptions) Devolve um Range objeto que representa a posição inicial do item especificado, como uma página, marcador ou campo.
merge(fileName: cadeia, opções?: Word. DocumentMergeOptions) Mescla as alterações marcadas com marcas de revisão de um documento para outro.
printOut(opções?: Word. DocumentPrintOutOptions) Imprime todo ou parte do documento.
protect(type: Word. ProtectionType, opções?: Word. DocumentProtectOptions) Protege o documento contra alterações não autorizadas.
replyWithChanges(opções?: Word. DocumentReplyWithChangesOptions) Envia uma mensagem de e-mail ao autor do documento que foi enviado para revisão, notificando-o de que um revisor concluiu a revisão do documento.
sendFaxOverInternet(opções?: Word. DocumentSendFaxOverInternetOptions) Envia o documento para um fornecedor de serviços de fax, que envia o documento por fax para um ou mais destinatários especificados.
sendForReview(opções?: Word. DocumentSendForReviewOptions) Envia o documento numa mensagem de e-mail para revisão pelos destinatários especificados.
DocumentCheckInOptions comentário Se for fornecido, especifica um comentário para a operação de marcar de entrada.
makePublic Se for fornecido, especifica se pretende tornar o documento público após marcar.
saveChanges Se for fornecido, especifica se pretende guardar as alterações antes de dar entrada.
DocumentCheckInWithVersionOptions comentário Se for fornecido, especifica um comentário para a operação de marcar de entrada.
makePublic Se for fornecido, especifica se pretende tornar o documento público após marcar.
saveChanges Se for fornecido, especifica se pretende guardar as alterações antes de dar entrada.
versionType Se for fornecido, especifica o tipo de versão para o marcar de entrada.
DocumentCheckSpellingOptions alwaysSuggest Se for fornecido, especifica se pretende sempre sugerir correções ortográficas.
customDictionary10 Se for fornecido, especifica um dicionário personalizado adicional a utilizar para a verificação ortográfica.
customDictionary2 Se for fornecido, especifica um dicionário personalizado adicional a utilizar para a verificação ortográfica.
customDictionary3 Se for fornecido, especifica um dicionário personalizado adicional a utilizar para a verificação ortográfica.
customDictionary4 Se for fornecido, especifica um dicionário personalizado adicional a utilizar para a verificação ortográfica.
customDictionary5 Se for fornecido, especifica um dicionário personalizado adicional a utilizar para a verificação ortográfica.
customDictionary6 Se for fornecido, especifica um dicionário personalizado adicional a utilizar para a verificação ortográfica.
customDictionary7 Se for fornecido, especifica um dicionário personalizado adicional a utilizar para a verificação ortográfica.
customDictionary8 Se for fornecido, especifica um dicionário personalizado adicional a utilizar para a verificação ortográfica.
customDictionary9 Se for fornecido, especifica um dicionário personalizado adicional a utilizar para a verificação ortográfica.
customDictionary Se for fornecido, especifica o dicionário personalizado a utilizar para a verificação ortográfica.
ignoreUppercase Se for fornecido, especifica se deve ignorar palavras em maiúsculas durante a verificação ortográfica.
DocumentCountNumberedItemsOptions level Se for fornecido, especifica o nível de numeração a contar.
numberType Se for fornecido, especifica o tipo de itens numerados a contar.
DocumentEndReviewOptions includeAttachment Se for fornecido, especifica se pretende incluir o documento como um anexo.
recipients Se for fornecido, especifica os destinatários a notificar quando terminar a revisão.
showMessage Se for fornecido, especifica se pretende mostrar a mensagem antes de enviar.
subject Se for fornecido, especifica o assunto do e-mail de notificação.
DocumentExportAsFixedFormat2Options bitmapMissingFonts Se for fornecido, especifica se existem tipos de letra em falta no mapa de bits.
createBookmarks Se for fornecido, especifica o modo de criação de marcadores.
documentStructureTags Se for fornecido, especifica se deve incluir etiquetas de estrutura de documentos.
fixedFormatExtClassPtr Se for fornecido, especifica o ponteiro da classe de extensão.
from Se for fornecido, especifica o número da página inicial.
includeDocProps Se for fornecido, especifica se deve incluir as propriedades do documento.
item Se for fornecido, especifica o item a exportar.
keepInformationRightsManagement Se for fornecido, especifica se pretende manter as definições de Gestão de Direitos de Informação (IRM).
openAfterExport Se for fornecido, especifica se pretende abrir o ficheiro após a exportação.
optimizeFor Se for fornecido, especifica o destino de otimização para a exportação.
optimizeForImageQuality Se for fornecido, especifica se pretende otimizar a qualidade da imagem no ficheiro exportado.
range Se for fornecido, especifica o intervalo a exportar.
to Se for fornecido, especifica o número de página final.
useIso19005_1 Se for fornecido, especifica se deve utilizar a conformidade ISO 19005-1.
DocumentExportAsFixedFormat3Options bitmapMissingFonts Se for fornecido, especifica se existem tipos de letra em falta no mapa de bits.
createBookmarks Se for fornecido, especifica o modo de criação de marcadores.
documentStructureTags Se for fornecido, especifica se deve incluir etiquetas de estrutura de documentos.
fixedFormatExtClassPtr Se for fornecido, especifica o ponteiro da classe de extensão.
from Se for fornecido, especifica o número da página inicial.
improveExportTagging Se for fornecido, especifica para melhorar a etiquetagem de exportação para uma melhor acessibilidade.
includeDocProps Se for fornecido, especifica se deve incluir as propriedades do documento.
item Se for fornecido, especifica o item a exportar.
keepInformationRightsManagement Se for fornecido, especifica se pretende manter as definições de Gestão de Direitos de Informação (IRM).
openAfterExport Se for fornecido, especifica se pretende abrir o ficheiro após a exportação.
optimizeFor Se for fornecido, especifica o destino de otimização para a exportação.
optimizeForImageQuality Se for fornecido, especifica se pretende otimizar a qualidade da imagem no ficheiro exportado.
range Se for fornecido, especifica o intervalo a exportar.
to Se for fornecido, especifica o número de página final.
useIso19005_1 Se for fornecido, especifica se deve utilizar a conformidade ISO 19005-1.
DocumentExportAsFixedFormatOptions bitmapMissingFonts Se for fornecido, especifica se existem tipos de letra em falta no mapa de bits.
createBookmarks Se for fornecido, especifica o modo de criação de marcadores.
documentStructureTags Se for fornecido, especifica se deve incluir etiquetas de estrutura de documentos.
fixedFormatExtensionClassPointer Se for fornecido, especifica o ponteiro da classe de extensão.
from Se for fornecido, especifica o número da página inicial.
includeDocProps Se for fornecido, especifica se deve incluir as propriedades do documento.
item Se for fornecido, especifica o item a exportar.
keepInformationRightsManagement Se for fornecido, especifica se pretende manter as definições de Gestão de Direitos de Informação (IRM).
openAfterExport Se for fornecido, especifica se pretende abrir o ficheiro após a exportação.
optimizeFor Se for fornecido, especifica o destino de otimização para a exportação.
range Se for fornecido, especifica o intervalo a exportar.
to Se for fornecido, especifica o número de página final.
useIso19005_1 Se for fornecido, especifica se deve utilizar a conformidade ISO 19005-1.
DocumentFollowHyperlinkOptions addHistory Se for fornecido, especifica se pretende adicionar a ligação ao histórico de navegação.
address Se for fornecido, especifica o endereço de hiperligação a seguir.
extraInfo Se for fornecido, especifica informações adicionais para transmitir com o pedido.
headerInfo Se for fornecido, especifica as informações de cabeçalho para o pedido HTTP.
httpMethod Se for fornecido, especifica o método HTTP a utilizar para o pedido.
newWindow Se for fornecido, especifica se pretende abrir a ligação numa nova janela.
sub-endereço Se for fornecido, especifica o sub-endereço no documento.
DocumentMergeOptions addToRecentFiles Se for fornecido, especifica se pretende adicionar o documento intercalado a ficheiros recentes.
detectFormatChanges Se for fornecido, especifica se pretende detetar alterações de formato durante a intercalação.
mergeTarget Se for fornecido, especifica o destino da operação de intercalação.
useFormattingFrom Se for fornecido, especifica a origem da formatação a utilizar na intercalação.
DocumentPrintOutOptions activePrinterMacGX Se for fornecido, especifica o nome da impressora.
acrescentar Se for fornecido, especifica se pretende anexar a um ficheiro existente.
fundo Se for fornecido, especifica se pretende imprimir em segundo plano.
agrupar Se for fornecido, especifica se pretende agrupar páginas.
cópias Se for fornecido, especifica o número de cópias a imprimir.
from Se for fornecido, especifica o número da página inicial.
item Se for fornecido, especifica o item a imprimir.
manualDuplexPrint Se for fornecido, especifica se pretende efetuar manualmente a impressão frente e verso.
outputFileName Se for fornecido, especifica o nome do ficheiro de saída.
pageType Se for fornecido, especifica a ordem da página.
pages Se for fornecido, especifica páginas específicas a imprimir.
printToFile Se for fornecido, especifica se pretende imprimir para o ficheiro.
printZoomColumn Se for fornecido, especifica a definição da coluna de zoom.
printZoomPaperHeight Se for fornecido, especifica a altura do papel para impressão em twips (20 twips = 1 ponto; 72 pontos = 1 polegada).
printZoomPaperWidth Se for fornecido, especifica a largura do papel para impressão em twips (20 twips = 1 ponto; 72 pontos = 1 polegada).
printZoomRow Se for fornecido, especifica a definição da linha de zoom.
range Se for fornecido, especifica o intervalo a imprimir.
to Se for fornecido, especifica o número de página final.
DocumentProtectOptions enforceStyleLock Se for fornecido, especifica se pretende impor restrições de bloqueio de estilo.
noReset Se for fornecido, especifica se pretende repor campos de formulário ao proteger o documento.
senha Se for fornecido, especifica a palavra-passe a aplicar para proteção de documentos.
useInformationRightsManagement Se for fornecido, especifica se pretende utilizar a Gestão de Direitos de Informação (IRM).
DocumentRangeOptions end Se for fornecido, especifica a posição do caráter final.
início Se for fornecido, especifica a posição do caráter inicial.
DocumentReplyWithChangesOptions includeAttachment Se for fornecido, especifica se pretende incluir o documento como um anexo.
recipients Se for fornecido, especifica os destinatários da resposta.
showMessage Se for fornecido, especifica se pretende mostrar a mensagem antes de enviar.
subject Se for fornecido, especifica o assunto do e-mail de resposta.
DocumentSendFaxOverInternetOptions recipients Se for fornecido, especifica os destinatários do fax.
showMessage Se for fornecido, especifica se pretende mostrar a mensagem antes de enviar.
subject Se for fornecido, especifica o assunto do fax.
DocumentSendForReviewOptions includeAttachment Se for fornecido, especifica se pretende incluir o documento como um anexo.
recipients Se for fornecido, especifica os destinatários do pedido de revisão.
showMessage Se for fornecido, especifica se pretende mostrar a mensagem antes de enviar.
subject Se for fornecido, especifica o assunto do e-mail de revisão.
GoToOptions Count Se for fornecido, especifica o número do item no documento.
direção Se for fornecido, especifica a direção para onde o intervalo ou seleção é movido.
item Se for fornecido, especifica o tipo de item para o que o intervalo ou seleção é movido.
name Se for fornecido, especifica o nome se a item propriedade estiver definida como Word. Tipo goToItem bookmark, comment, fieldou object.
IndexCollection getItem(index: number) Obtém um Index objeto pelo respetivo índice na coleção.
ListTemplateAddOptions name Se for fornecido, especifica o nome do modelo de lista a adicionar.
outlineNumbered Se for fornecido, especifica se deve aplicar numeração hierárquica ao novo modelo de lista.
ListTemplateCollection add(options?: Word. ListTemplateAddOptions) Adiciona um novo ListTemplate objeto.
getItem(index: number) Obtém um ListTemplate objeto pelo respetivo índice na coleção.
ListTemplateGalleryCollection getItem(index: number) Obtém um ListTemplateGallery objeto pelo respetivo índice na coleção.
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.
underline Especifica o tipo de sublinhado aplicado ao intervalo.
RangeScopedCollection getItem(index: number) Obtém um Range objeto pelo respetivo índice na coleção.
RepeatingSectionContentControl xmlMapping Devolve um XmlMapping objeto que representa o mapeamento do controlo de conteúdo para dados XML no arquivo de dados do documento.
ReviewerCollection getItem(index: number) Devolve um Reviewer objeto que representa o item especificado na coleção.
RevisionCollection getItem(index: number) Devolve um Revision objeto que representa o item especificado na coleção.
Selection convertToTable(opções?: Word. SelectionConvertToTableOptions) Converte o texto dentro de um intervalo em uma tabela.
goTo(options?: Word. GoToOptions) Devolve um Range objeto que representa a área especificada pelo options e move o ponto de inserção para a posição do caráter imediatamente antes do item especificado.
SelectionConvertToTableOptions applyBorders Se for fornecido, especifica se deve aplicar limites à tabela do formato especificado.
applyColor Se for fornecido, especifica se pretende aplicar formatação de cor à tabela do formato especificado.
applyFirstColumn Se for fornecido, especifica se deve aplicar formatação especial à primeira coluna do formato especificado.
applyFont Se for fornecido, especifica se pretende aplicar formatação de tipo de letra à tabela do formato especificado.
applyHeadingRows Se for fornecido, especifica se pretende formatar a primeira linha como uma linha de cabeçalho do formato especificado.
applyLastColumn Se for fornecido, especifica se pretende aplicar formatação especial à última coluna do formato especificado.
applyLastRow Se for fornecido, especifica se pretende aplicar formatação especial à última linha do formato especificado.
applyShading Se for fornecido, especifica se pretende aplicar sombreado à tabela do formato especificado.
Ajuste automático Se for fornecido, especifica se pretende redimensionar automaticamente a tabela para se ajustar aos conteúdos.
Ajuste AutomáticoBehavior Se for fornecido, especifica o comportamento de ajuste automático da tabela.
defaultTableBehavior Se for fornecido, especifica se a Microsoft Word redimensiona automaticamente as células numa tabela para se ajustarem aos conteúdos.
format Se for fornecido, especifica um formato predefinido a aplicar à tabela.
initialColumnWidth Se for fornecido, especifica a largura inicial de cada coluna na tabela, em pontos.
numColumns Se for fornecido, especifica o número de colunas na tabela.
numRows Se for fornecido, especifica o número de linhas na tabela.
separador Se for fornecido, especifica o caráter utilizado para separar o texto em células.
SourceCollection getItem(index: number) Obtém um Source pelo respetivo índice na coleção.
Estilo description Obtém a descrição do estilo.
TabStopCollection getItem(index: number) Obtém um TabStop objeto pelo respetivo índice na coleção.
Janela state Especifica o estado da janela do documento ou da janela de tarefas.
XmlNode type Obtém o tipo de nó.
value Especifica o valor deste nó XML.
XmlNodeCollection getItem(index: number) Obtém um XmlNode objeto pelo respetivo índice na coleção.

Confira também

  • Last updated on