Word. Document class

Usada por

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml

// Gets the current change tracking mode.
await Word.run(async (context) => {
  const document: Word.Document = context.document;
  document.load("changeTrackingMode");
  await context.sync();

  if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
    console.log("Only my changes are being tracked.");
  } else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
    console.log("Everyone's changes are being tracked.");
  } else {
    console.log("No changes are being tracked.");
  }
});

Propriedades

activeTheme	Obtém o nome do tema ativo e as opções de formatação.
activeThemeDisplayName	Obtém o nome de exibição do tema ativo.
activeWindow	Obtém a janela ativa para o documento.
areFilePropertiesPasswordEncrypted	Determina se o Word criptografa propriedades de arquivo para documentos protegidos por senha.
areGrammaticalErrorsShown	Especifica se os erros gramaticais são marcados por uma linha verde ondulada no documento.
areMathDefaultsUsed	Especifica se as configurações matemáticas padrão devem ser usadas ao criar novas equações.
areNewerFeaturesDisabled	Especifica se os recursos introduzidos após uma versão especificada devem ser desabilitados.
areSpellingErrorsShown	Especifica se o Microsoft Word sublinha erros de ortografia no documento.
areStylesUpdatedOnOpen	Especifica se os estilos neste documento são atualizados para corresponder aos estilos no modelo anexado sempre que o documento é aberto.
areTrueTypeFontsEmbedded	Especifica se o Microsoft Word incorpora fontes TrueType no documento quando ele é salvo.
attachedTemplate	Especifica um `Template` objeto que representa o modelo anexado ao documento.
autoHyphenation	Especifica se a hifenização automática está ativada para o documento.
autoSaveOn	Especifica se as edições no documento são salvas automaticamente.
background	Obtém um `Shape` objeto que representa a imagem de plano de fundo do documento.
bibliography	Retorna um `Bibliography` objeto que representa as referências bibliográficas contidas no documento.
body	Obtém o `Body` objeto do documento principal. O corpo é o texto que exclui cabeçalhos, rodapés, notas de rodapé, caixas de texto, etc.
bookmarks	Retorna um `BookmarkCollection` objeto que representa todos os indicadores no documento.
builtInDocumentProperties	Obtém um `DocumentProperties` objeto que representa todas as propriedades internas do documento para o documento.
changeTrackingMode	Especifica o modo ChangeTracking.
characters	Obtém o `RangeScopedCollection` objeto que representa todos os caracteres no documento.
coauthoring	Obtém um `Coauthoring` objeto para gerenciar a coautoria no documento.
codeName	Obtém o nome de código do documento.
comments	Obtém um `CommentCollection` objeto que representa todos os comentários no documento.
compatibilityMode	Obtém o modo de compatibilidade que o Word usa ao abrir o documento.
consecutiveHyphensLimit	Especifica o número máximo de linhas consecutivas que podem terminar com hifens.
content	Obtém um `Range` objeto que representa a história do documento principal.
contentControls	Obtém a coleção de `ContentControl` objetos no documento. Isso inclui controles de conteúdo no corpo do documento, cabeçalhos, rodapés, caixas de texto, etc.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
currentRsid	Obtém um número aleatório que o Word atribui às alterações no documento.
customDocumentProperties	Obtém uma `DocumentProperties` coleção que representa todas as propriedades personalizadas do documento.
customXmlParts	Obtém as partes XML personalizadas no documento.
defaultTabStop	Especifica o intervalo (em pontos) entre as paradas de tabulação padrão no documento.
defaultTargetFrame	Especifica o quadro do navegador para exibir uma página da Web por meio de hiperlink.
documentLibraryVersions	Retorna um `DocumentLibraryVersionCollection` objeto que representa a coleção de versões de um documento compartilhado que tem o controle de versão habilitado e que está armazenado em uma biblioteca de documentos em um servidor.
doNotEmbedSystemFonts	Especifica se o Word não deve incorporar fontes comuns do sistema.
encryptionProvider	Especifica o nome do provedor de criptografia de algoritmo que o Microsoft Word usa ao criptografar documentos.
farEastLineBreakLanguage	Especifica o idioma do Leste Asiático usado para quebra de linha.
farEastLineBreakLevel	Especifica o nível de controle de quebra de linha.
fields	Obtém um `FieldCollection` objeto que representa todos os campos no documento.
formattingIsNextLevelShown	Especifica se o Word mostra o próximo nível de título quando o anterior é usado.
formattingIsUserStyleNameShown	Especifica se os estilos definidos pelo usuário devem ser exibidos.
frames	Retorna um `FrameCollection` objeto que representa todos os quadros no documento.
fullName	Obtém o nome de um documento, incluindo o caminho.
grammaticalErrors	Obtém um `RangeCollection` objeto que representa as frases que não passaram na verificação gramatical marcado no documento.
gridDistanceHorizontal	Especifica o espaço horizontal entre as linhas de grade invisíveis que o Microsoft Word usa ao desenhar, mover e redimensionar caracteres de AutoFormas ou do Leste Asiático no documento.
gridDistanceVertical	Especifica o espaço vertical entre as linhas de grade invisíveis que o Microsoft Word usa ao desenhar, mover e redimensionar AutoFormas ou caracteres do Leste Asiático no documento.
gridIsOriginFromMargin	Especifica se a grade de caracteres começa no canto superior esquerdo da página.
gridOriginHorizontal	Especifica o ponto de origem horizontal da grade invisível.
gridOriginVertical	Especifica o ponto de origem vertical da grade invisível.
gridSpaceBetweenHorizontalLines	Especifica o intervalo para linhas de grade de caracteres horizontais no modo de exibição layout de impressão.
gridSpaceBetweenVerticalLines	Especifica o intervalo para linhas de grade de caracteres verticais no modo de exibição layout de impressão.
hasPassword	Obtém se uma senha é necessária para abrir o documento.
hasVbProject	Determina se o documento tem um projeto do Microsoft Visual Basic for Applications anexado.
hyperlinks	Retorna um `HyperlinkCollection` objeto que representa todos os hiperlinks no documento.
hyphenateCaps	Especifica se as palavras em todas as letras maiúsculas podem ser hifenizadas.
hyphenationZone	Especifica a largura da zona de hifenização, em pontos.
indexes	Retorna um `IndexCollection` objeto que representa todos os índices no documento.
isAutoFormatOverrideOn	Especifica se as opções de formatação automática substituem as restrições de formatação.
isChartDataPointTracked	Especifica se os gráficos no documento ativo usam o rastreamento de ponto de dados de referência de célula.
isCompatible	Especifica se a opção de compatibilidade especificada pela `type` propriedade está habilitada.
isFinal	Especifica se o documento é final.
isFontsSubsetSaved	Especifica se o Microsoft Word salva um subconjunto de fontes TrueType incorporadas com o documento.
isFormsDataPrinted	Especifica se o Microsoft Word imprime em um formulário pré-impresso apenas os dados inseridos no formulário online correspondente.
isFormsDataSaved	Especifica se o Microsoft Word salva os dados inseridos em um formulário como um registro delimitado por tabulação para uso em um banco de dados.
isGrammarChecked	Especifica se uma verificação marcar gramatical foi executada no documento.
isInAutoSave	Obtém se o `Application.DocumentBeforeSave` acionamento mais recente do evento foi o resultado de um salvamento automático pelo documento ou um salvamento manual pelo usuário.
isInFormsDesign	Determina se o documento está no modo de design de formulário.
isKerningByAlgorithm	Especifica se o Word cria kerns em caracteres latinos de meia largura e marcas de pontuação.
isLinguisticDataEmbedded	Especifica se os dados de fala e manuscrito devem ser incorporados.
isMasterDocument	Obtém se esse documento é um documento master.
isOptimizedForWord97	Especifica se o Word otimiza o documento para o Word 97.
isPostScriptPrintedOverText	Especifica se as instruções de campo PRINT (como comandos PostScript) no documento devem ser impressas sobre texto e gráficos quando uma impressora PostScript é usada.
isQuickStyleSetLocked	Especifica se os usuários podem alterar o conjunto de Estilo Rápido.
isReadOnly	Determina se as alterações no documento não podem ser salvas no documento original.
isReadOnlyRecommended	Especifica se o Microsoft Word exibe uma caixa de mensagem sempre que um usuário abre o documento, sugerindo que ele seja aberto como somente leitura.
isSnappedToGrid	Especifica se as AutoFormas ou caracteres do Leste Asiático são alinhados automaticamente com uma grade invisível.
isSnappedToShapes	Especifica se as AutoFormas ou caracteres do Leste Asiático se alinham com linhas de grade invisíveis por meio de outras formas.
isSpellingChecked	Especifica se a verificação ortográfica foi realizada em todo o documento.
isStyleEnforced	Especifica se as restrições de formatação são impostas em um documento protegido.
isSubdocument	Determina se esse documento é um subdocumento de um documento master.
isThemeLocked	Especifica se os usuários podem alterar o tema do documento.
isUserControl	Especifica se o documento foi criado ou aberto pelo usuário.
isVbaSigned	Determina se o projeto VBA está assinado digitalmente.
isWriteReserved	Determina se o documento está protegido com uma senha de gravação.
justificationMode	Especifica o ajuste do espaçamento entre caracteres.
kind	Especifica o tipo de formato que o Microsoft Word usa ao formatar automaticamente o documento.
languageDetected	Especifica se o Microsoft Word detectou o idioma do texto do documento.
listParagraphs	Obtém um `ParagraphCollection` objeto que representa todos os parágrafos numerados no documento.
lists	Obtém um `ListCollection` objeto que contém todas as listas formatadas no documento.
listTemplates	Retorna um `ListTemplateCollection` objeto que representa todos os modelos de lista no documento.
noLineBreakAfter	Especifica os caracteres kinsoku após os quais o Word não quebrará uma linha.
noLineBreakBefore	Especifica os caracteres kinsoku antes dos quais o Word não quebrará uma linha.
openEncoding	Obtém a codificação usada para abrir o documento.
originalDocumentTitle	Obtém o título do documento original após a comparação legal-blackline.
pageSetup	Retorna um `PageSetup` objeto associado ao documento.
paragraphs	Obtém um `ParagraphCollection` objeto que representa todos os parágrafos no documento.
password	Define uma senha que deve ser fornecida para abrir o documento.
passwordEncryptionAlgorithm	Obtém o algoritmo usado para criptografia de senha.
passwordEncryptionKeyLength	Obtém o comprimento da chave usado para criptografia de senha.
passwordEncryptionProvider	Obtém o nome do provedor de criptografia de senha.
path	Obtém o disco ou o caminho da Web para o documento (exclui o nome do documento).
printRevisions	Especifica se as marcas de revisão são impressas com o documento.
properties	Obtém as propriedades do documento.
protectionType	Obtém o tipo de proteção para o documento.
readabilityStatistics	Obtém um `ReadabilityStatisticCollection` objeto que representa as estatísticas de legibilidade do documento.
readingLayoutSizeX	Especifica a largura das páginas no modo de exibição de layout de leitura quando congeladas.
readingLayoutSizeY	Especifica a altura das páginas no modo de exibição de layout de leitura quando congeladas.
readingModeIsLayoutFrozen	Especifica se as páginas no modo de exibição de layout de leitura são congeladas para marcação manuscrita.
removePersonalInformationOnSave	Especifica se o Word remove as informações do usuário ao salvar.
revisedDocumentTitle	Obtém o título do documento revisado após a comparação legal-blackline.
revisions	Obtém a coleção de revisões que representa as alterações controladas no documento.
saved	Indica se as alterações do documento foram salvas. Um valor de `true` indica que o documento não foi alterado desde que foi salvo.
saveEncoding	Especifica a codificação usada ao salvar o documento.
saveFormat	Obtém o formato de arquivo do documento.
sections	Obtém a coleção de `Section` objetos no documento.
selection	Retorna um `Selection` objeto que representa a seleção atual no documento.
sensitivityLabel	Retorna o rótulo de confidencialidade do documento.
sentences	Obtém o `RangeScopedCollection` objeto que representa todas as frases no documento.
settings	Obtém as configurações do suplemento no documento.
spellingErrors	Obtém um `RangeCollection` objeto que representa as palavras identificadas como erros de ortografia no documento.
storyRanges	Obtém um `RangeCollection` objeto que representa todas as histórias no documento.
styles	Recebe um `StyleCollection` para o documento.
tableOfAuthoritiesCategories	Retorna um `TableOfAuthoritiesCategoryCollection` objeto que representa o índice de autoridades categorias disponíveis no documento.
tables	Obtém um `TableCollection` objeto que representa todas as tabelas no documento.
tablesOfAuthorities	Retorna um `TableOfAuthoritiesCollection` objeto que representa todas as tabelas de autoridades no documento.
tablesOfContents	Retorna um `TableOfContentsCollection` objeto que representa todos os sumários no documento.
tablesOfFigures	Retorna um `TableOfFiguresCollection` objeto que representa todos os índices de figuras no documento.
textEncoding	Especifica a codificação para salvar como texto codificado.
textLineEnding	Especifica como o Word marca as quebras de linha e de parágrafo em arquivos de texto.
trackedChangesAreDateAndTimeRemoved	Especifica se deseja remover ou armazenar metadados de data e hora para alterações controladas.
trackFormatting	Especifica se deseja controlar as alterações de formatação quando o controle de alterações está ativado.
trackMoves	Especifica se o texto movido deve ser marcado quando o Controle de Alterações estiver ativado.
trackRevisions	Especifica se as alterações são controladas no documento.
type	Obtém o tipo de documento (modelo ou documento).
webSettings	Obtém o `WebSettings` objeto para atributos relacionados à página da Web.
windows	Obtém a coleção de `Word.Window` objetos para o documento.
words	Obtém o `RangeScopedCollection` objeto que representa cada palavra no documento.
writePassword	Define uma senha para salvar as alterações no documento.
xmlAreAdvancedErrorsShown	Especifica se as mensagens de erro são geradas a partir de mensagens internas do Word ou MSXML (Microsoft XML).
xmlIsXsltUsedWhenSaving	Especifica se um documento deve ser salvo por meio de uma Transformação de linguagem de folha de estilo extensível (XSLT).
xmlSaveThroughXslt	Especifica o caminho e o nome do arquivo para o XSLT a ser aplicado ao salvar um documento.

Métodos

acceptAllRevisions()	Aceita todas as alterações controladas no documento.
acceptAllRevisionsShown()	Aceita todas as revisões no documento exibidas na tela.
activate()	Ativa o documento para que ele se torne o documento ativo.
addStyle(name, type)	Adiciona um estilo ao documento por nome e tipo.
addStyle(name, type)	Adiciona um estilo ao documento por nome e tipo.
addToFavorites()	Cria um atalho para o documento ou hiperlink e o adiciona à pasta Favoritos .
applyQuickStyleSet(style)	Aplica o conjunto de Estilos Rápidos ao documento.
applyQuickStyleSet(style)	Aplica o conjunto de Estilos Rápidos ao documento.
applyTheme(name)	Aplica o tema especificado a esse documento.
autoFormat()	Formata o documento automaticamente.
canCheckin()	Retorna `true` se o Microsoft Word pode marcar no documento para um servidor.
checkConsistencyJapanese()	Procura todo texto em um documento em idioma japonês e exibe instâncias onde o uso de caracteres está inconsistente para as mesmas palavras.
checkGrammar()	Inicia uma marca ortográfica e gramatical do documento.
checkIn(options)	Faz check-in do documento do computador local para um servidor e define o documento local como somente leitura, para que ele não possa ser editado localmente.
checkInWithVersion(options)	Salva o documento em um servidor de um computador local e define o documento local como somente leitura, para que ele não possa ser editado localmente.
checkSpelling(options)	Inicia uma verificação marca ortográfica para o documento.
close(closeBehavior)	Fecha o documento atual. Observação: não há suporte para essa API no Word na Web.
close(closeBehavior)	Fecha o documento atual. Observação: não há suporte para essa API no Word na Web.
closePrintPreview()	Alterna o documento da visualização de impressão para o modo de exibição anterior.
compare(filePath, documentCompareOptions)	Exibe marcas de revisão que indicam onde o documento especificado difere de um outro documento.
compareFromBase64(base64File, documentCompareOptions)	Exibe marcas de revisão que indicam onde o documento especificado difere de um outro documento.
computeStatistics(statistic, includeFootnotesAndEndnotes)	Retorna uma estatística com base no conteúdo do documento.
computeStatistics(statistic, includeFootnotesAndEndnotes)	Retorna uma estatística com base no conteúdo do documento.
convert()	Converte o arquivo no formato mais recente e habilita todos os recursos.
convertAutoHyphens()	converte hifens automáticos em hífens manuais.
convertNumbersToText(numberType)	Altera os números da lista e os campos LISTNUM do documento para texto.
convertNumbersToText(numberType)	Altera os números da lista e os campos LISTNUM do documento para texto.
convertVietnameseDocument(codePageOrigin)	Reconverte um documento do idioma vietnamita para Unicode usando uma página de código diferente da página padrão.
copyStylesFromTemplate(StyleTemplate)	Copia estilos do modelo especificado para o documento.
countNumberedItems(options)	Retorna o número de itens numerados ou com marcadores e os campos LISTNUM no documento.
deleteAllComments()	Exclui todos os comentários do documento.
deleteAllCommentsShown()	Exclui todas as revisões no documento que são exibidas na tela.
deleteAllInkAnnotations()	Exclui todas as anotações à tinta manuscritas no documento.
deleteBookmark(name)	Exclui um marcador, se existir, do documento.
detectLanguage()	Analisa o texto do documento para determinar o idioma.
endReview(options)	Encerra uma revisão do arquivo que foi enviado para revisão.
exportAsFixedFormat(outputFileName, exportFormat, options)	Salva o documento no formato PDF ou XPS.
exportAsFixedFormat(outputFileName, exportFormat, options)	Salva o documento no formato PDF ou XPS.
exportAsFixedFormat2(outputFileName, exportFormat, options)	Salva o documento no formato PDF ou XPS.
exportAsFixedFormat2(outputFileName, exportFormat, options)	Salva o documento no formato PDF ou XPS.
exportAsFixedFormat3(outputFileName, exportFormat, options)	Salva o documento no formato PDF ou XPS com marcação aprimorada.
exportAsFixedFormat3(outputFileName, exportFormat, options)	Salva o documento no formato PDF ou XPS com marcação aprimorada.
fitToPages()	Diminui o tamanho da fonte do texto apenas o suficiente para que a contagem de páginas do documento caia em um.
followHyperlink(options)	Exibe um documento armazenado no cache, caso já tenha sido baixado. Caso contrário, esse método resolve o hiperlink, baixa o documento alvo e exibe o documento no aplicativo adequado.
freezeLayout()	Corrige o layout do documento no modo de exibição da Web.
getAnnotationById(id)	Obtém a anotação por ID. Gera um `ItemNotFound` erro se a anotação não for encontrada.
getBookmarkRange(name)	Obtém o intervalo de um indicador. Gera um `ItemNotFound` erro se o indicador não existir.
getBookmarkRangeOrNullObject(name)	Obtém o intervalo de um indicador. Se o indicador não existir, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte métodos e propriedades *OrNullObject.
getContentControls(options)	Obtém os controles de conteúdo com suporte no momento no documento.
getCrossReferenceItems(referenceType)	Retorna uma matriz de itens que pode ser baseada em referência cruzada no tipo de referência cruzada especificada.
getCrossReferenceItems(referenceType)	Retorna uma matriz de itens que pode ser baseada em referência cruzada no tipo de referência cruzada especificada.
getEndnoteBody()	Obtém as notas de fim do documento em um único corpo.
getFootnoteBody()	Obtém as notas de rodapé do documento em um único corpo.
getParagraphByUniqueLocalId(id)	Obtém o parágrafo por sua ID local exclusiva. Lançará um `ItemNotFound` erro se a coleção estiver vazia.
getRange(options)	Retorna um `Range` objeto usando as posições de caractere iniciais e finais especificadas.
getSelection()	Obtém a seleção atual do documento. Não há suporte para várias seleções.
getStyles()	Obtém um `StyleCollection` objeto que representa todo o conjunto de estilos do documento.
goTo(options)	Retorna um `Range` objeto que representa a posição inicial do item especificado, como uma página, um indicador ou um campo.
importStylesFromJson(stylesJson, importedStylesConflictBehavior)	Importe estilos de uma cadeia de caracteres formatada em JSON.
importStylesFromJson(stylesJson, importedStylesConflictBehavior)	Importe estilos de uma cadeia de caracteres formatada em JSON.
insertFileFromBase64(base64File, insertLocation, insertFileOptions)	Insere um documento no documento de destino em um local específico com propriedades adicionais. Cabeçalhos, rodapés, marcas d'água e outras propriedades de seção são copiadas por padrão.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
lockServerFile()	Bloqueia o arquivo no servidor, impedindo que outro usuário realize a edição.
makeCompatibilityDefault()	Define as opções de compatibilidade.
manualHyphenation()	Inicializa a hifenização manual de um documento, uma linha de cada vez.
merge(fileName, options)	Mescla as alterações marcadas com marcas de revisão de um documento para outro.
post()	Posta o documento em uma pasta pública no Microsoft Exchange.
presentIt()	Abre o PowerPoint com o documento do Word carregado.
printOut(options)	Imprime todo o documento ou parte dele.
printPreview()	Alterna para o modo de visualização de impressão.
protect(type, options)	Protege o documento contra alterações não autorizadas.
protect(type, options)	Protege o documento contra alterações não autorizadas.
redo(times)	Refaz a última ação que foi desfeita (inverte o `undo` método).
rejectAllRevisions()	Rejeita todas as alterações controladas no documento.
rejectAllRevisionsShown()	Rejeita todas as revisões no documento exibidas na tela.
reload()	Recarrega um documento armazenado no cache resolvendo o hiperlink para o documento e baixando-o.
reloadAs(encoding)	Recarrega o documento com base em um documento HTML, usando a codificação do documento.
reloadAs(encoding)	Recarrega o documento com base em um documento HTML, usando a codificação do documento.
removeDocumentInformation(removeDocInfoType)	Remove informações confidenciais, propriedades, comentários e outros metadados do documento.
removeDocumentInformation(removeDocInfoType)	Remove informações confidenciais, propriedades, comentários e outros metadados do documento.
removeLockedStyles()	Limpa o documento de estilos bloqueados quando restrições de formatação foram aplicadas no documento.
removeNumbers(numberType)	Remove números ou marcadores do documento.
removeNumbers(numberType)	Remove números ou marcadores do documento.
removeTheme()	Remove o tema ativo do documento atual.
repaginate()	Repagina todo o documento.
replyWithChanges(options)	Envia uma mensagem de email ao autor do documento que foi enviado para revisão, notificando-o de que um revisor concluiu a revisão do documento.
resetFormFields()	Limpa todos os campos do formulário no documento, preparando o formulário a ser preenchido novamente.
returnToLastReadPosition()	Retorna o documento para a última posição de leitura salva.
runAutoMacro(autoMacro)	Executa uma macro automática que é armazenada no documento. Se a macro automática especificada não existir, nada acontecerá.
runAutoMacro(autoMacro)	Executa uma macro automática que é armazenada no documento. Se a macro automática especificada não existir, nada acontecerá.
save(saveBehavior, fileName)	Salva o documento.
save(saveBehavior, fileName)	Salva o documento.
saveAsQuickStyleSet(fileName)	Salva o grupo de estilos rápidos atualmente em uso.
search(searchText, searchOptions)	Executa uma pesquisa com as opções de pesquisa especificadas no escopo do documento inteiro. Os resultados da pesquisa são uma coleção de `Range` objetos.
select()	Seleciona o conteúdo do documento.
selectContentControlsByTag(tag)	Retorna todos os controles de conteúdo com a marca especificada.
selectContentControlsByTitle(title)	Retorna um `ContentControlCollection` objeto que representa todos os controles de conteúdo no documento com o título especificado.
selectLinkedControls(node)	Retorna um `ContentControlCollection` objeto que representa todos os controles de conteúdo no documento que estão vinculados ao nó XML personalizado específico.
selectNodes(xPath, options)	Retorna um `XmlNodeCollection` objeto que representa todos os nós que correspondem ao parâmetro XPath na ordem em que aparecem no documento.
selectSingleNode(xPath, options)	Retorna um `XmlNode` objeto que representa o primeiro nó que corresponde ao parâmetro XPath no documento.
selectUnlinkedControls(stream)	Retorna um `ContentControlCollection` objeto que representa todos os controles de conteúdo no documento que não estão vinculados a um nó XML.
sendFax(address, subject)	Envia o documento como um fax, sem nenhuma interação do usuário.
sendFaxOverInternet(options)	Envia o documento para um provedor de serviços de fax, que o envia por fax para um ou mais destinatários especificados.
sendForReview(options)	Envia o documento em uma mensagem de email para revisão pelos destinatários especificados.
sendMail()	Abre uma janela de mensagem para enviar o documento pelo Microsoft Exchange.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
setDefaultTableStyle(style, setInTemplate)	Especifica o estilo de tabela a ser usado para tabelas recém-criadas no documento.
setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)	Define as opções que o Microsoft Word usa para criptografar documentos com senhas.
toggleFormsDesign()	Ativa ou desativa o modo de design do formulário .
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`, por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o objeto original `Word.Document` é um objeto de API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Word.Interfaces.DocumentData`) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre `.sync` chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
transformDocument(path, dataOnly)	Aplica o arquivo XSLT (Extensible Stylesheet Language Transformation) especificado a esse documento e substitui o documento pelos resultados.
undo(times)	Desfaz a última ação ou sequência de ações, exibidas na lista Desfazer.
undoClear()	Limpa a lista de ações que podem ser desfeitas no documento.
unprotect(password)	Remove a proteção do documento.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar `context.sync()` antes que a liberação de memória entre em vigor.
updateStyles()	Copia todos os estilos do modelo anexado para o documento, sobrescrevendo quaisquer estilos existentes no documento que tenham o mesmo nome.
viewCode()	Exibe a janela de código para o controle ActiveX da Microsoft selecionado no documento.
viewPropertyBrowser()	Exibe a janela de propriedades do controle ActiveX da Microsoft selecionado no documento.
webPagePreview()	Exibe uma visualização do documento atual como ele ficaria se fosse salvo como uma página da Web.

Eventos

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.
onAnnotationPopupAction	Ocorre quando o usuário executa uma ação em um menu pop-up de anotação.
onAnnotationRemoved	Ocorre quando o usuário exclui uma ou mais anotações.
onContentControlAdded	Ocorre quando um controle de conteúdo é adicionado. Execute context.sync() no manipulador para obter as propriedades do novo controle de conteúdo.
onParagraphAdded	Ocorre quando o usuário adiciona novos parágrafos.
onParagraphChanged	Ocorre quando o usuário altera parágrafos.
onParagraphDeleted	Ocorre quando o usuário exclui parágrafos.

activeTheme

Obtém o nome do tema ativo e as opções de formatação.

readonly activeTheme: string;

Valor da propriedade

string

Comentários

activeThemeDisplayName

Obtém o nome de exibição do tema ativo.

readonly activeThemeDisplayName: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: WordApiDesktop 1.2

activeWindow

Obtém a janela ativa para o documento.

readonly activeWindow: Word.Window;

Valor da propriedade

Word.Window

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the first paragraph of each page.
  console.log("Getting first paragraph of each page...");

  // Get the active window.
  const activeWindow: Word.Window = context.document.activeWindow;
  activeWindow.load();

  // Get the active pane.
  const activePane: Word.Pane = activeWindow.activePane;
  activePane.load();

  // Get all pages.
  const pages: Word.PageCollection = activePane.pages;
  pages.load();

  await context.sync();

  // Get page index and paragraphs of each page.
  const pagesIndexes = [];
  const pagesNumberOfParagraphs = [];
  const pagesFirstParagraphText = [];
  for (let i = 0; i < pages.items.length; i++) {
    const page = pages.items[i];
    page.load("index");
    pagesIndexes.push(page);

    const paragraphs = page.getRange().paragraphs;
    paragraphs.load("items/length");
    pagesNumberOfParagraphs.push(paragraphs);

    const firstParagraph = paragraphs.getFirst();
    firstParagraph.load("text");
    pagesFirstParagraphText.push(firstParagraph);
  }

  await context.sync();

  for (let i = 0; i < pagesIndexes.length; i++) {
    console.log(`Page index: ${pagesIndexes[i].index}`);
    console.log(`Number of paragraphs: ${pagesNumberOfParagraphs[i].items.length}`);
    console.log("First paragraph's text:", pagesFirstParagraphText[i].text);
  }
});

areFilePropertiesPasswordEncrypted

Determina se o Word criptografa propriedades de arquivo para documentos protegidos por senha.

readonly areFilePropertiesPasswordEncrypted: boolean;

Valor da propriedade

boolean

Comentários

areGrammaticalErrorsShown

Especifica se os erros gramaticais são marcados por uma linha verde ondulada no documento.

areGrammaticalErrorsShown: boolean;

Valor da propriedade

boolean

Comentários

areMathDefaultsUsed

Especifica se as configurações matemáticas padrão devem ser usadas ao criar novas equações.

areMathDefaultsUsed: boolean;

Valor da propriedade

boolean

Comentários

areNewerFeaturesDisabled

Especifica se os recursos introduzidos após uma versão especificada devem ser desabilitados.

areNewerFeaturesDisabled: boolean;

Valor da propriedade

boolean

Comentários

areSpellingErrorsShown

Especifica se o Microsoft Word sublinha erros de ortografia no documento.

areSpellingErrorsShown: boolean;

Valor da propriedade

boolean

Comentários

areStylesUpdatedOnOpen

Especifica se os estilos neste documento são atualizados para corresponder aos estilos no modelo anexado sempre que o documento é aberto.

areStylesUpdatedOnOpen: boolean;

Valor da propriedade

boolean

Comentários

areTrueTypeFontsEmbedded

Especifica se o Microsoft Word incorpora fontes TrueType no documento quando ele é salvo.

areTrueTypeFontsEmbedded: boolean;

Valor da propriedade

boolean

Comentários

attachedTemplate

Especifica um Template objeto que representa o modelo anexado ao documento.

attachedTemplate: Word.Template;

Valor da propriedade

Word.Template

Comentários

autoHyphenation

Especifica se a hifenização automática está ativada para o documento.

autoHyphenation: boolean;

Valor da propriedade

boolean

Comentários

autoSaveOn

Especifica se as edições no documento são salvas automaticamente.

autoSaveOn: boolean;

Valor da propriedade

boolean

Comentários

background

Obtém um Shape objeto que representa a imagem de plano de fundo do documento.

readonly background: Word.Shape;

Valor da propriedade

Word.Shape

Comentários

bibliography

Retorna um Bibliography objeto que representa as referências bibliográficas contidas no documento.

readonly bibliography: Word.Bibliography;

Valor da propriedade

Word.Bibliography

Comentários

body

Obtém o Body objeto do documento principal. O corpo é o texto que exclui cabeçalhos, rodapés, notas de rodapé, caixas de texto, etc.

readonly body: Word.Body;

Valor da propriedade

Word.Body

Comentários

bookmarks

Retorna um BookmarkCollection objeto que representa todos os indicadores no documento.

readonly bookmarks: Word.BookmarkCollection;

Valor da propriedade

Word.BookmarkCollection

Comentários

builtInDocumentProperties

Obtém um DocumentProperties objeto que representa todas as propriedades internas do documento para o documento.

readonly builtInDocumentProperties: Word.DocumentProperties;

Valor da propriedade

Word.DocumentProperties

Comentários

changeTrackingMode

Especifica o modo ChangeTracking.

changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";

Valor da propriedade

Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml

// Gets the current change tracking mode.
await Word.run(async (context) => {
  const document: Word.Document = context.document;
  document.load("changeTrackingMode");
  await context.sync();

  if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
    console.log("Only my changes are being tracked.");
  } else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
    console.log("Everyone's changes are being tracked.");
  } else {
    console.log("No changes are being tracked.");
  }
});

characters

Obtém o RangeScopedCollection objeto que representa todos os caracteres no documento.

readonly characters: Word.RangeScopedCollection;

Valor da propriedade

Word.RangeScopedCollection

Comentários

coauthoring

Obtém um Coauthoring objeto para gerenciar a coautoria no documento.

readonly coauthoring: Word.Coauthoring;

Valor da propriedade

Word.Coauthoring

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthors.yaml

// Gets the coauthoring capabilities and pending-update status of the document.
await Word.run(async (context) => {
  const coauthoring: Word.Coauthoring = context.document.coauthoring;
  coauthoring.load("canCoauthor,canMerge,pendingUpdates");
  await context.sync();

  console.log("Can coauthor:", coauthoring.canCoauthor);
  console.log("Can merge:", coauthoring.canMerge);
  console.log("Pending updates:", coauthoring.pendingUpdates);
});

codeName

Obtém o nome de código do documento.

readonly codeName: string;

Valor da propriedade

string

Comentários

comments

Obtém um CommentCollection objeto que representa todos os comentários no documento.

readonly comments: Word.CommentCollection;

Valor da propriedade

Word.CommentCollection

Comentários

compatibilityMode

Obtém o modo de compatibilidade que o Word usa ao abrir o documento.

readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current";

Valor da propriedade

Comentários

consecutiveHyphensLimit

Especifica o número máximo de linhas consecutivas que podem terminar com hifens.

consecutiveHyphensLimit: number;

Valor da propriedade

number

Comentários

content

Obtém um Range objeto que representa a história do documento principal.

readonly content: Word.Range;

Valor da propriedade

Word.Range

Comentários

contentControls

Obtém a coleção de ContentControl objetos no documento. Isso inclui controles de conteúdo no corpo do documento, cabeçalhos, rodapés, caixas de texto, etc.

readonly contentControls: Word.ContentControlCollection;

Valor da propriedade

Word.ContentControlCollection

Comentários

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

currentRsid

Obtém um número aleatório que o Word atribui às alterações no documento.

readonly currentRsid: number;

Valor da propriedade

number

Comentários

customDocumentProperties

Obtém uma DocumentProperties coleção que representa todas as propriedades personalizadas do documento.

readonly customDocumentProperties: Word.DocumentProperties;

Valor da propriedade

Word.DocumentProperties

Comentários

customXmlParts

Obtém as partes XML personalizadas no documento.

readonly customXmlParts: Word.CustomXmlPartCollection;

Valor da propriedade

Word.CustomXmlPartCollection

Comentários

defaultTabStop

Especifica o intervalo (em pontos) entre as paradas de tabulação padrão no documento.

defaultTabStop: number;

Valor da propriedade

number

Comentários

defaultTargetFrame

Especifica o quadro do navegador para exibir uma página da Web por meio de hiperlink.

defaultTargetFrame: string;

Valor da propriedade

string

Comentários

documentLibraryVersions

Retorna um DocumentLibraryVersionCollection objeto que representa a coleção de versões de um documento compartilhado que tem o controle de versão habilitado e que está armazenado em uma biblioteca de documentos em um servidor.

readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;

Valor da propriedade

Word.DocumentLibraryVersionCollection

Comentários

doNotEmbedSystemFonts

Especifica se o Word não deve incorporar fontes comuns do sistema.

doNotEmbedSystemFonts: boolean;

Valor da propriedade

boolean

Comentários

encryptionProvider

Especifica o nome do provedor de criptografia de algoritmo que o Microsoft Word usa ao criptografar documentos.

encryptionProvider: string;

Valor da propriedade

string

Comentários

farEastLineBreakLanguage

Especifica o idioma do Leste Asiático usado para quebra de linha.

farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese";

Valor da propriedade

Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"

Comentários

farEastLineBreakLevel

Especifica o nível de controle de quebra de linha.

farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom";

Valor da propriedade

Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"

Comentários

fields

Obtém um FieldCollection objeto que representa todos os campos no documento.

readonly fields: Word.FieldCollection;

Valor da propriedade

Word.FieldCollection

Comentários

formattingIsNextLevelShown

Especifica se o Word mostra o próximo nível de título quando o anterior é usado.

formattingIsNextLevelShown: boolean;

Valor da propriedade

boolean

Comentários

formattingIsUserStyleNameShown

Especifica se os estilos definidos pelo usuário devem ser exibidos.

formattingIsUserStyleNameShown: boolean;

Valor da propriedade

boolean

Comentários

frames

Retorna um FrameCollection objeto que representa todos os quadros no documento.

readonly frames: Word.FrameCollection;

Valor da propriedade

Word.FrameCollection

Comentários

fullName

Obtém o nome de um documento, incluindo o caminho.

readonly fullName: string;

Valor da propriedade

string

Comentários

grammaticalErrors

Obtém um RangeCollection objeto que representa as frases que não passaram na verificação gramatical marcado no documento.

readonly grammaticalErrors: Word.RangeCollection;

Valor da propriedade

Word.RangeCollection

Comentários

gridDistanceHorizontal

Especifica o espaço horizontal entre as linhas de grade invisíveis que o Microsoft Word usa ao desenhar, mover e redimensionar caracteres de AutoFormas ou do Leste Asiático no documento.

gridDistanceHorizontal: number;

Valor da propriedade

number

Comentários

gridDistanceVertical

Especifica o espaço vertical entre as linhas de grade invisíveis que o Microsoft Word usa ao desenhar, mover e redimensionar AutoFormas ou caracteres do Leste Asiático no documento.

gridDistanceVertical: number;

Valor da propriedade

number

Comentários

gridIsOriginFromMargin

Especifica se a grade de caracteres começa no canto superior esquerdo da página.

gridIsOriginFromMargin: boolean;

Valor da propriedade

boolean

Comentários

gridOriginHorizontal

Especifica o ponto de origem horizontal da grade invisível.

gridOriginHorizontal: number;

Valor da propriedade

number

Comentários

gridOriginVertical

Especifica o ponto de origem vertical da grade invisível.

gridOriginVertical: number;

Valor da propriedade

number

Comentários

gridSpaceBetweenHorizontalLines

Especifica o intervalo para linhas de grade de caracteres horizontais no modo de exibição layout de impressão.

gridSpaceBetweenHorizontalLines: number;

Valor da propriedade

number

Comentários

gridSpaceBetweenVerticalLines

Especifica o intervalo para linhas de grade de caracteres verticais no modo de exibição layout de impressão.

gridSpaceBetweenVerticalLines: number;

Valor da propriedade

number

Comentários

hasPassword

Obtém se uma senha é necessária para abrir o documento.

readonly hasPassword: boolean;

Valor da propriedade

boolean

Comentários

hasVbProject

Determina se o documento tem um projeto do Microsoft Visual Basic for Applications anexado.

readonly hasVbProject: boolean;

Valor da propriedade

boolean

Comentários

hyperlinks

Retorna um HyperlinkCollection objeto que representa todos os hiperlinks no documento.

readonly hyperlinks: Word.HyperlinkCollection;

Valor da propriedade

Word.HyperlinkCollection

Comentários

hyphenateCaps

Especifica se as palavras em todas as letras maiúsculas podem ser hifenizadas.

hyphenateCaps: boolean;

Valor da propriedade

boolean

Comentários

hyphenationZone

Especifica a largura da zona de hifenização, em pontos.

hyphenationZone: number;

Valor da propriedade

number

Comentários

indexes

Retorna um IndexCollection objeto que representa todos os índices no documento.

readonly indexes: Word.IndexCollection;

Valor da propriedade

Word.IndexCollection

Comentários

isAutoFormatOverrideOn

Especifica se as opções de formatação automática substituem as restrições de formatação.

isAutoFormatOverrideOn: boolean;

Valor da propriedade

boolean

Comentários

isChartDataPointTracked

Especifica se os gráficos no documento ativo usam o rastreamento de ponto de dados de referência de célula.

isChartDataPointTracked: boolean;

Valor da propriedade

boolean

Comentários

isCompatible

Especifica se a opção de compatibilidade especificada pela type propriedade está habilitada.

isCompatible: boolean;

Valor da propriedade

boolean

Comentários

isFinal

Especifica se o documento é final.

isFinal: boolean;

Valor da propriedade

boolean

Comentários

isFontsSubsetSaved

Especifica se o Microsoft Word salva um subconjunto de fontes TrueType incorporadas com o documento.

isFontsSubsetSaved: boolean;

Valor da propriedade

boolean

Comentários

isFormsDataPrinted

Especifica se o Microsoft Word imprime em um formulário pré-impresso apenas os dados inseridos no formulário online correspondente.

isFormsDataPrinted: boolean;

Valor da propriedade

boolean

Comentários

isFormsDataSaved

Especifica se o Microsoft Word salva os dados inseridos em um formulário como um registro delimitado por tabulação para uso em um banco de dados.

isFormsDataSaved: boolean;

Valor da propriedade

boolean

Comentários

isGrammarChecked

Especifica se uma verificação marcar gramatical foi executada no documento.

isGrammarChecked: boolean;

Valor da propriedade

boolean

Comentários

isInAutoSave

Obtém se o Application.DocumentBeforeSave acionamento mais recente do evento foi o resultado de um salvamento automático pelo documento ou um salvamento manual pelo usuário.

readonly isInAutoSave: boolean;

Valor da propriedade

boolean

Comentários

isInFormsDesign

Determina se o documento está no modo de design de formulário.

readonly isInFormsDesign: boolean;

Valor da propriedade

boolean

Comentários

isKerningByAlgorithm

Especifica se o Word cria kerns em caracteres latinos de meia largura e marcas de pontuação.

isKerningByAlgorithm: boolean;

Valor da propriedade

boolean

Comentários

isLinguisticDataEmbedded

Especifica se os dados de fala e manuscrito devem ser incorporados.

isLinguisticDataEmbedded: boolean;

Valor da propriedade

boolean

Comentários

isMasterDocument

Obtém se esse documento é um documento master.

readonly isMasterDocument: boolean;

Valor da propriedade

boolean

Comentários

isOptimizedForWord97

Especifica se o Word otimiza o documento para o Word 97.

isOptimizedForWord97: boolean;

Valor da propriedade

boolean

Comentários

isPostScriptPrintedOverText

Especifica se as instruções de campo PRINT (como comandos PostScript) no documento devem ser impressas sobre texto e gráficos quando uma impressora PostScript é usada.

isPostScriptPrintedOverText: boolean;

Valor da propriedade

boolean

Comentários

isQuickStyleSetLocked

Especifica se os usuários podem alterar o conjunto de Estilo Rápido.

isQuickStyleSetLocked: boolean;

Valor da propriedade

boolean

Comentários

isReadOnly

Determina se as alterações no documento não podem ser salvas no documento original.

readonly isReadOnly: boolean;

Valor da propriedade

boolean

Comentários

isReadOnlyRecommended

Especifica se o Microsoft Word exibe uma caixa de mensagem sempre que um usuário abre o documento, sugerindo que ele seja aberto como somente leitura.

isReadOnlyRecommended: boolean;

Valor da propriedade

boolean

Comentários

isSnappedToGrid

Especifica se as AutoFormas ou caracteres do Leste Asiático são alinhados automaticamente com uma grade invisível.

isSnappedToGrid: boolean;

Valor da propriedade

boolean

Comentários

isSnappedToShapes

Especifica se as AutoFormas ou caracteres do Leste Asiático se alinham com linhas de grade invisíveis por meio de outras formas.

isSnappedToShapes: boolean;

Valor da propriedade

boolean

Comentários

isSpellingChecked

Especifica se a verificação ortográfica foi realizada em todo o documento.

isSpellingChecked: boolean;

Valor da propriedade

boolean

Comentários

isStyleEnforced

Especifica se as restrições de formatação são impostas em um documento protegido.

isStyleEnforced: boolean;

Valor da propriedade

boolean

Comentários

isSubdocument

Determina se esse documento é um subdocumento de um documento master.

readonly isSubdocument: boolean;

Valor da propriedade

boolean

Comentários

isThemeLocked

Especifica se os usuários podem alterar o tema do documento.

isThemeLocked: boolean;

Valor da propriedade

boolean

Comentários

isUserControl

Especifica se o documento foi criado ou aberto pelo usuário.

isUserControl: boolean;

Valor da propriedade

boolean

Comentários

isVbaSigned

Determina se o projeto VBA está assinado digitalmente.

readonly isVbaSigned: boolean;

Valor da propriedade

boolean

Comentários

isWriteReserved

Determina se o documento está protegido com uma senha de gravação.

readonly isWriteReserved: boolean;

Valor da propriedade

boolean

Comentários

justificationMode

Especifica o ajuste do espaçamento entre caracteres.

justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana";

Valor da propriedade

Word.JustificationMode | "Expand" | "Compress" | "CompressKana"

Comentários

kind

Especifica o tipo de formato que o Microsoft Word usa ao formatar automaticamente o documento.

kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email";

Valor da propriedade

Word.DocumentKind | "NotSpecified" | "Letter" | "Email"

Comentários

languageDetected

Especifica se o Microsoft Word detectou o idioma do texto do documento.

languageDetected: boolean;

Valor da propriedade

boolean

Comentários

listParagraphs

Obtém um ParagraphCollection objeto que representa todos os parágrafos numerados no documento.

readonly listParagraphs: Word.ParagraphCollection;

Valor da propriedade

Word.ParagraphCollection

Comentários

lists

Obtém um ListCollection objeto que contém todas as listas formatadas no documento.

readonly lists: Word.ListCollection;

Valor da propriedade

Word.ListCollection

Comentários

listTemplates

Retorna um ListTemplateCollection objeto que representa todos os modelos de lista no documento.

readonly listTemplates: Word.ListTemplateCollection;

Valor da propriedade

Word.ListTemplateCollection

Comentários

noLineBreakAfter

Especifica os caracteres kinsoku após os quais o Word não quebrará uma linha.

noLineBreakAfter: string;

Valor da propriedade

string

Comentários

noLineBreakBefore

Especifica os caracteres kinsoku antes dos quais o Word não quebrará uma linha.

noLineBreakBefore: string;

Valor da propriedade

string

Comentários

openEncoding

Obtém a codificação usada para abrir o documento.

readonly openEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Valor da propriedade

Comentários

originalDocumentTitle

Obtém o título do documento original após a comparação legal-blackline.

readonly originalDocumentTitle: string;

Valor da propriedade

string

Comentários

pageSetup

Retorna um PageSetup objeto associado ao documento.

readonly pageSetup: Word.PageSetup;

Valor da propriedade

Word.PageSetup

Comentários

paragraphs

Obtém um ParagraphCollection objeto que representa todos os parágrafos no documento.

readonly paragraphs: Word.ParagraphCollection;

Valor da propriedade

Word.ParagraphCollection

Comentários

password

Define uma senha que deve ser fornecida para abrir o documento.

password: string;

Valor da propriedade

string

Comentários

passwordEncryptionAlgorithm

Obtém o algoritmo usado para criptografia de senha.

readonly passwordEncryptionAlgorithm: string;

Valor da propriedade

string

Comentários

passwordEncryptionKeyLength

Obtém o comprimento da chave usado para criptografia de senha.

readonly passwordEncryptionKeyLength: number;

Valor da propriedade

number

Comentários

passwordEncryptionProvider

Obtém o nome do provedor de criptografia de senha.

readonly passwordEncryptionProvider: string;

Valor da propriedade

string

Comentários

path

Obtém o disco ou o caminho da Web para o documento (exclui o nome do documento).

readonly path: string;

Valor da propriedade

string

Comentários

printRevisions

Especifica se as marcas de revisão são impressas com o documento.

printRevisions: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApi 1.3

properties

Obtém as propriedades do documento.

readonly properties: Word.DocumentProperties;

Valor da propriedade

Word.DocumentProperties

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml

await Word.run(async (context) => {
    const builtInProperties: Word.DocumentProperties = context.document.properties;
    builtInProperties.load("*"); // Let's get all!

    await context.sync();
    console.log(JSON.stringify(builtInProperties, null, 4));
});

protectionType

Obtém o tipo de proteção para o documento.

readonly protectionType: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading";

Valor da propriedade

Comentários

readabilityStatistics

Obtém um ReadabilityStatisticCollection objeto que representa as estatísticas de legibilidade do documento.

readonly readabilityStatistics: Word.ReadabilityStatisticCollection;

Valor da propriedade

Word.ReadabilityStatisticCollection

Comentários

readingLayoutSizeX

Especifica a largura das páginas no modo de exibição de layout de leitura quando congeladas.

readingLayoutSizeX: number;

Valor da propriedade

number

Comentários

readingLayoutSizeY

Especifica a altura das páginas no modo de exibição de layout de leitura quando congeladas.

readingLayoutSizeY: number;

Valor da propriedade

number

Comentários

readingModeIsLayoutFrozen

Especifica se as páginas no modo de exibição de layout de leitura são congeladas para marcação manuscrita.

readingModeIsLayoutFrozen: boolean;

Valor da propriedade

boolean

Comentários

removePersonalInformationOnSave

Especifica se o Word remove as informações do usuário ao salvar.

removePersonalInformationOnSave: boolean;

Valor da propriedade

boolean

Comentários

revisedDocumentTitle

Obtém o título do documento revisado após a comparação legal-blackline.

readonly revisedDocumentTitle: string;

Valor da propriedade

string

Comentários

revisions

Obtém a coleção de revisões que representa as alterações controladas no documento.

readonly revisions: Word.RevisionCollection;

Valor da propriedade

Word.RevisionCollection

Comentários

saved

Indica se as alterações do documento foram salvas. Um valor de true indica que o documento não foi alterado desde que foi salvo.

readonly saved: boolean;

Valor da propriedade

boolean

Comentários

saveEncoding

Especifica a codificação usada ao salvar o documento.

saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Valor da propriedade

Comentários

saveFormat

Obtém o formato de arquivo do documento.

readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument";

Valor da propriedade

Comentários

sections

Obtém a coleção de Section objetos no documento.

readonly sections: Word.SectionCollection;

Valor da propriedade

Word.SectionCollection

Comentários

selection

Retorna um Selection objeto que representa a seleção atual no documento.

readonly selection: Word.Selection;

Valor da propriedade

Word.Selection

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/55-selection/insert-formula.yaml

// Inserts a formula field without specifying the formula expression.
// Word determines the formula automatically based on adjacent cell values:
// if there are values above the cell, it inserts =SUM(ABOVE);
// if there are values to the left, it inserts =SUM(LEFT).
// The selection must be in a table cell with at least one adjacent cell that contains a value.
await Word.run(async (context) => {
  const options: Word.SelectionInsertFormulaOptions = {
    numberFormat: "#,##0.00",
  };
  context.document.selection.insertFormula(options);
  await context.sync();

  console.log("Inserted formula (auto-determined by Word) with number format.");
});

sensitivityLabel

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna o rótulo de confidencialidade do documento.

readonly sensitivityLabel: Word.SensitivityLabel;

Valor da propriedade

Word.SensitivityLabel

Comentários

sentences

Obtém o RangeScopedCollection objeto que representa todas as frases no documento.

readonly sentences: Word.RangeScopedCollection;

Valor da propriedade

Word.RangeScopedCollection

Comentários

settings

Obtém as configurações do suplemento no documento.

readonly settings: Word.SettingCollection;

Valor da propriedade

Word.SettingCollection

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml

// Gets all custom settings this add-in set on this document.
await Word.run(async (context) => {
  const settings: Word.SettingCollection = context.document.settings;
  settings.load("items");
  await context.sync();

  if (settings.items.length == 0) {
    console.log("There are no settings.");
  } else {
    console.log("All settings:");
    for (let i = 0; i < settings.items.length; i++) {
      console.log(settings.items[i]);
    }
  }
});

spellingErrors

Obtém um RangeCollection objeto que representa as palavras identificadas como erros de ortografia no documento.

readonly spellingErrors: Word.RangeCollection;

Valor da propriedade

Word.RangeCollection

Comentários

storyRanges

Obtém um RangeCollection objeto que representa todas as histórias no documento.

readonly storyRanges: Word.RangeCollection;

Valor da propriedade

Word.RangeCollection

Comentários

styles

Recebe um StyleCollection para o documento.

readonly styles: Word.StyleCollection;

Valor da propriedade

Word.StyleCollection

Comentários

tableOfAuthoritiesCategories

Retorna um TableOfAuthoritiesCategoryCollection objeto que representa o índice de autoridades categorias disponíveis no documento.

readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection;

Valor da propriedade

Word.TableOfAuthoritiesCategoryCollection

Comentários

tables

Obtém um TableCollection objeto que representa todas as tabelas no documento.

readonly tables: Word.TableCollection;

Valor da propriedade

Word.TableCollection

Comentários

tablesOfAuthorities

Retorna um TableOfAuthoritiesCollection objeto que representa todas as tabelas de autoridades no documento.

readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;

Valor da propriedade

Word.TableOfAuthoritiesCollection

Comentários

tablesOfContents

Retorna um TableOfContentsCollection objeto que representa todos os sumários no documento.

readonly tablesOfContents: Word.TableOfContentsCollection;

Valor da propriedade

Word.TableOfContentsCollection

Comentários

tablesOfFigures

Retorna um TableOfFiguresCollection objeto que representa todos os índices de figuras no documento.

readonly tablesOfFigures: Word.TableOfFiguresCollection;

Valor da propriedade

Word.TableOfFiguresCollection

Comentários

textEncoding

Especifica a codificação para salvar como texto codificado.

textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

Valor da propriedade

Comentários

textLineEnding

Especifica como o Word marca as quebras de linha e de parágrafo em arquivos de texto.

textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps";

Valor da propriedade

Comentários

trackedChangesAreDateAndTimeRemoved

Especifica se deseja remover ou armazenar metadados de data e hora para alterações controladas.

trackedChangesAreDateAndTimeRemoved: boolean;

Valor da propriedade

boolean

Comentários

trackFormatting

Especifica se deseja controlar as alterações de formatação quando o controle de alterações está ativado.

trackFormatting: boolean;

Valor da propriedade

boolean

Comentários

trackMoves

Especifica se o texto movido deve ser marcado quando o Controle de Alterações estiver ativado.

trackMoves: boolean;

Valor da propriedade

boolean

Comentários

trackRevisions

Especifica se as alterações são controladas no documento.

trackRevisions: boolean;

Valor da propriedade

boolean

Comentários

type

Obtém o tipo de documento (modelo ou documento).

readonly type: Word.DocumentType | "Document" | "Template" | "Frameset";

Valor da propriedade

Word.DocumentType | "Document" | "Template" | "Frameset"

Comentários

webSettings

Obtém o WebSettings objeto para atributos relacionados à página da Web.

readonly webSettings: Word.WebSettings;

Valor da propriedade

Word.WebSettings

Comentários

Conjunto de APIs: WordApiDesktop 1.2

windows

Obtém a coleção de Word.Window objetos para o documento.

readonly windows: Word.WindowCollection;

Valor da propriedade

Word.WindowCollection

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the document windows.
  const windows: Word.WindowCollection = context.document.windows;
  windows.load("windows/items/length");

  await context.sync();

  console.log(`Number of windows for this document: ${windows.items.length}`);
});

words

Obtém o RangeScopedCollection objeto que representa cada palavra no documento.

readonly words: Word.RangeScopedCollection;

Valor da propriedade

Word.RangeScopedCollection

Comentários

writePassword

Define uma senha para salvar as alterações no documento.

writePassword: string;

Valor da propriedade

string

Comentários

xmlAreAdvancedErrorsShown

Especifica se as mensagens de erro são geradas a partir de mensagens internas do Word ou MSXML (Microsoft XML).

xmlAreAdvancedErrorsShown: boolean;

Valor da propriedade

boolean

Comentários

xmlIsXsltUsedWhenSaving

Especifica se um documento deve ser salvo por meio de uma Transformação de linguagem de folha de estilo extensível (XSLT).

xmlIsXsltUsedWhenSaving: boolean;

Valor da propriedade

boolean

Comentários

xmlSaveThroughXslt

Especifica o caminho e o nome do arquivo para o XSLT a ser aplicado ao salvar um documento.

xmlSaveThroughXslt: string;

Valor da propriedade

string

Comentários

acceptAllRevisions()

Aceita todas as alterações controladas no documento.

acceptAllRevisions(): void;

Retornos

void

Comentários

acceptAllRevisionsShown()

Aceita todas as revisões no documento exibidas na tela.

acceptAllRevisionsShown(): void;

Retornos

void

Comentários

activate()

Ativa o documento para que ele se torne o documento ativo.

activate(): void;

Retornos

void

Comentários

addStyle(name, type)

Adiciona um estilo ao documento por nome e tipo.

addStyle(name: string, type: Word.StyleType): Word.Style;

Parâmetros

name: string

Uma cadeia de caracteres que representa o nome do estilo.

type: Word.StyleType

O tipo de estilo, incluindo caractere, lista, parágrafo ou tabela.

Retornos

Word.Style

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Adds a new style.
await Word.run(async (context) => {
  const newStyleName = (document.getElementById("new-style-name") as HTMLInputElement).value;
  if (newStyleName == "") {
    console.warn("Enter a style name to add.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(newStyleName);
  style.load();
  await context.sync();

  if (!style.isNullObject) {
    console.warn(
      `There's an existing style with the same name '${newStyleName}'! Please provide another style name.`
    );
    return;
  }

  const newStyleType = ((document.getElementById("new-style-type") as HTMLSelectElement).value as unknown) as Word.StyleType;
  context.document.addStyle(newStyleName, newStyleType);
  await context.sync();

  console.log(newStyleName + " has been added to the style list.");
});

addStyle(name, type)

Adiciona um estilo ao documento por nome e tipo.

addStyle(name: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;

Parâmetros

name: string

Uma cadeia de caracteres que representa o nome do estilo.

type: "Character" | "List" | "Paragraph" | "Table"

O tipo de estilo, incluindo caractere, lista, parágrafo ou tabela.

Retornos

Word.Style

Comentários

addToFavorites()

Cria um atalho para o documento ou hiperlink e o adiciona à pasta Favoritos .

addToFavorites(): void;

Retornos

void

Comentários

applyQuickStyleSet(style)

Aplica o conjunto de Estilos Rápidos ao documento.

applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void;

Parâmetros

style: Word.ApplyQuickStyleSet

O estilo definido a ser aplicado.

Retornos

void

Comentários

applyQuickStyleSet(style)

Aplica o conjunto de Estilos Rápidos ao documento.

applyQuickStyleSet(style: "SessionStart" | "Template"): void;

Parâmetros

style: "SessionStart" | "Template"

O estilo definido a ser aplicado.

Retornos

void

Comentários

applyTheme(name)

Aplica o tema especificado a esse documento.

applyTheme(name: string): void;

Parâmetros

name: string

O nome do tema.

Retornos

void

Comentários

autoFormat()

Formata o documento automaticamente.

autoFormat(): void;

Retornos

void

Comentários

canCheckin()

Retorna true se o Microsoft Word pode marcar no documento para um servidor.

canCheckin(): OfficeExtension.ClientResult<boolean>;

Retornos

OfficeExtension.ClientResult<boolean>

true se o documento puder ser verificado; caso contrário, false.

Comentários

checkConsistencyJapanese()

Procura todo texto em um documento em idioma japonês e exibe instâncias onde o uso de caracteres está inconsistente para as mesmas palavras.

checkConsistencyJapanese(): void;

Retornos

void

Comentários

checkGrammar()

Inicia uma marca ortográfica e gramatical do documento.

checkGrammar(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

checkIn(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Faz check-in do documento do computador local para um servidor e define o documento local como somente leitura, para que ele não possa ser editado localmente.

checkIn(options?: Word.DocumentCheckInOptions): void;

Parâmetros

options: Word.DocumentCheckInOptions

Opcional. Opções de configuração para fazer check-in do documento.

Retornos

void

Comentários

checkInWithVersion(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Salva o documento em um servidor de um computador local e define o documento local como somente leitura, para que ele não possa ser editado localmente.

checkInWithVersion(options?: Word.DocumentCheckInWithVersionOptions): void;

Parâmetros

options: Word.DocumentCheckInWithVersionOptions

Opcional. Opções de configuração para check-in do documento com controle de versão.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

checkSpelling(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Inicia uma verificação marca ortográfica para o documento.

checkSpelling(options?: Word.DocumentCheckSpellingOptions): void;

Parâmetros

options: Word.DocumentCheckSpellingOptions

Opcional. Opções de configuração para a operação de verificação ortográfica.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

close(closeBehavior)

Fecha o documento atual.

Observação: não há suporte para essa API no Word na Web.

close(closeBehavior?: Word.CloseBehavior): void;

Parâmetros

closeBehavior: Word.CloseBehavior

Opcional. O comportamento de fechamento deve ser save ou skipSave. O valor padrão é save.

Retornos

void

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Closes the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.close();
});

close(closeBehavior)

Fecha o documento atual.

Observação: não há suporte para essa API no Word na Web.

close(closeBehavior?: "Save" | "SkipSave"): void;

Parâmetros

closeBehavior: "Save" | "SkipSave"

Opcional. O comportamento de fechamento deve ser save ou skipSave. O valor padrão é save.

Retornos

void

Comentários

closePrintPreview()

Alterna o documento da visualização de impressão para o modo de exibição anterior.

closePrintPreview(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.1

compare(filePath, documentCompareOptions)

Exibe marcas de revisão que indicam onde o documento especificado difere de um outro documento.

compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

Parâmetros

filePath: string

O caminho do documento com o qual o documento especificado é comparado.

documentCompareOptions: Word.DocumentCompareOptions

Opcional. As opções adicionais que especificam o comportamento de comparação de documentos.

Retornos

void

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/compare-documents.yaml

// Compares the current document with a specified external document.
await Word.run(async (context) => {
  // Absolute path of an online or local document.
  const filePath = (document.getElementById("filePath") as HTMLInputElement).value;
  // Options that configure the compare operation.
  const options: Word.DocumentCompareOptions = {
    compareTarget: Word.CompareTarget.compareTargetCurrent,
    detectFormatChanges: false
    // Other options you choose...
    };
  context.document.compare(filePath, options);

  await context.sync();

  console.log("Differences shown in the current document.");
});

compareFromBase64(base64File, documentCompareOptions)

Exibe marcas de revisão que indicam onde o documento especificado difere de um outro documento.

compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

Parâmetros

base64File: string

O conteúdo codificado em Base64 do documento com o qual o documento especificado é comparado.

documentCompareOptions: Word.DocumentCompareOptions

Opcional. As opções adicionais que especificam o comportamento para comparar os documentos. Observe que a compareTarget opção não tem permissão para estar compareTargetSelected nesta API.

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.2

computeStatistics(statistic, includeFootnotesAndEndnotes)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna uma estatística com base no conteúdo do documento.

computeStatistics(statistic: Word.StatisticType, includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

Parâmetros

statistic: Word.StatisticType

O tipo de estatística a ser retornada.

includeFootnotesAndEndnotes: boolean

Opcional. Se deve incluir notas de rodapé e notas de fim. O valor padrão é false.

Retornos

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

Comentários

computeStatistics(statistic, includeFootnotesAndEndnotes)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna uma estatística com base no conteúdo do documento.

computeStatistics(statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters", includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

Parâmetros

statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters"

O tipo de estatística a ser retornada.

includeFootnotesAndEndnotes: boolean

Opcional. Se deve incluir notas de rodapé e notas de fim. O valor padrão é false.

Retornos

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

Comentários

convert()

Converte o arquivo no formato mais recente e habilita todos os recursos.

convert(): void;

Retornos

void

Comentários

convertAutoHyphens()

converte hifens automáticos em hífens manuais.

convertAutoHyphens(): void;

Retornos

void

Comentários

convertNumbersToText(numberType)

Altera os números da lista e os campos LISTNUM do documento para texto.

convertNumbersToText(numberType?: Word.NumberType): void;

Parâmetros

numberType: Word.NumberType

Opcional. O tipo de numeração a ser convertido.

Retornos

void

Comentários

convertNumbersToText(numberType)

Altera os números da lista e os campos LISTNUM do documento para texto.

convertNumbersToText(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

Parâmetros

numberType: "Paragraph" | "ListNum" | "AllNumbers"

Opcional. O tipo de numeração a ser convertido.

Retornos

void

Comentários

convertVietnameseDocument(codePageOrigin)

Reconverte um documento do idioma vietnamita para Unicode usando uma página de código diferente da página padrão.

convertVietnameseDocument(codePageOrigin: number): void;

Parâmetros

codePageOrigin: number

A página de código a ser usada.

Retornos

void

Comentários

copyStylesFromTemplate(StyleTemplate)

Copia estilos do modelo especificado para o documento.

copyStylesFromTemplate(StyleTemplate: string): void;

Parâmetros

StyleTemplate: string

O modelo do qual copiar estilos.

Retornos

void

Comentários

countNumberedItems(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna o número de itens numerados ou com marcadores e os campos LISTNUM no documento.

countNumberedItems(options?: Word.DocumentCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;

Parâmetros

options: Word.DocumentCountNumberedItemsOptions

Opcional. Opções de configuração para contar itens numerados.

Retornos

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

A contagem de itens numerados.

Comentários

deleteAllComments()

Exclui todos os comentários do documento.

deleteAllComments(): void;

Retornos

void

Comentários

deleteAllCommentsShown()

Exclui todas as revisões no documento que são exibidas na tela.

deleteAllCommentsShown(): void;

Retornos

void

Comentários

deleteAllInkAnnotations()

Exclui todas as anotações à tinta manuscritas no documento.

deleteAllInkAnnotations(): void;

Retornos

void

Comentários

deleteBookmark(name)

Exclui um marcador, se existir, do documento.

deleteBookmark(name: string): void;

Parâmetros

name: string

O nome do indicador que não diferencia maiúsculas de minúsculas.

Retornos

void

Comentários

detectLanguage()

Analisa o texto do documento para determinar o idioma.

detectLanguage(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

endReview(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Encerra uma revisão do arquivo que foi enviado para revisão.

endReview(options?: Word.DocumentEndReviewOptions): void;

Parâmetros

options: Word.DocumentEndReviewOptions

Opcional. Opções de configuração para encerrar o processo de revisão.

Retornos

void

Comentários

exportAsFixedFormat(outputFileName, exportFormat, options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Salva o documento no formato PDF ou XPS.

exportAsFixedFormat(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormatOptions): void;

Parâmetros

outputFileName: string

O nome do arquivo de saída.

exportFormat: Word.ExportFormat

O formato de exportação.

options: Word.DocumentExportAsFixedFormatOptions

Opcional. Opções de configuração para a operação de exportação.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/export.yaml

await Word.run(async (context) => {
  const document: Word.Document = context.document;

  // Export the current document as a PDF saved in your default location, usually Documents.
  const filename = `exported-doc-${getCurrentDate()}.pdf`;
  console.log(`File name: ${filename}`);
  const options: Word.DocumentExportAsFixedFormatOptions = {
    item: Word.ExportItem.documentContent,
    openAfterExport: true,
    optimizeFor: Word.ExportOptimizeFor.onScreen,
  };

  // If a file with the same name already exists at the default location, it's silently overwritten.
  document.exportAsFixedFormat(filename, Word.ExportFormat.pdf, options);

  await context.sync();
});

exportAsFixedFormat(outputFileName, exportFormat, options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Salva o documento no formato PDF ou XPS.

exportAsFixedFormat(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormatOptions): void;

Parâmetros

outputFileName: string

O nome do arquivo de saída.

exportFormat: "Pdf" | "Xps"

O formato de exportação.

options: Word.DocumentExportAsFixedFormatOptions

Opcional. Opções de configuração para a operação de exportação.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

exportAsFixedFormat2(outputFileName, exportFormat, options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Salva o documento no formato PDF ou XPS.

exportAsFixedFormat2(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat2Options): void;

Parâmetros

outputFileName: string

O nome do arquivo de saída.

exportFormat: Word.ExportFormat

O formato a ser exportado (PDF/XPS).

options: Word.DocumentExportAsFixedFormat2Options

Opcional. Opções de configuração para a operação de exportação.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

exportAsFixedFormat2(outputFileName, exportFormat, options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Salva o documento no formato PDF ou XPS.

exportAsFixedFormat2(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat2Options): void;

Parâmetros

outputFileName: string

O nome do arquivo de saída.

exportFormat: "Pdf" | "Xps"

O formato a ser exportado (PDF/XPS).

options: Word.DocumentExportAsFixedFormat2Options

Opcional. Opções de configuração para a operação de exportação.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

exportAsFixedFormat3(outputFileName, exportFormat, options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Salva o documento no formato PDF ou XPS com marcação aprimorada.

exportAsFixedFormat3(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat3Options): void;

Parâmetros

outputFileName: string

O nome do arquivo de saída.

exportFormat: Word.ExportFormat

O formato a ser exportado (PDF/XPS).

options: Word.DocumentExportAsFixedFormat3Options

Opcional. Opções de configuração para a operação de exportação.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

exportAsFixedFormat3(outputFileName, exportFormat, options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Salva o documento no formato PDF ou XPS com marcação aprimorada.

exportAsFixedFormat3(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat3Options): void;

Parâmetros

outputFileName: string

O nome do arquivo de saída.

exportFormat: "Pdf" | "Xps"

O formato a ser exportado (PDF/XPS).

options: Word.DocumentExportAsFixedFormat3Options

Opcional. Opções de configuração para a operação de exportação.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

fitToPages()

Diminui o tamanho da fonte do texto apenas o suficiente para que a contagem de páginas do documento caia em um.

fitToPages(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

followHyperlink(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Exibe um documento armazenado no cache, caso já tenha sido baixado. Caso contrário, esse método resolve o hiperlink, baixa o documento alvo e exibe o documento no aplicativo adequado.

followHyperlink(options?: Word.DocumentFollowHyperlinkOptions): void;

Parâmetros

options: Word.DocumentFollowHyperlinkOptions

Opcional. Opções de configuração para seguir o hiperlink.

Retornos

void

Comentários

freezeLayout()

Corrige o layout do documento no modo de exibição da Web.

freezeLayout(): void;

Retornos

void

Comentários

getAnnotationById(id)

Obtém a anotação por ID. Gera um ItemNotFound erro se a anotação não for encontrada.

getAnnotationById(id: string): Word.Annotation;

Parâmetros

id: string

A ID da anotação a ser obtida.

Retornos

Word.Annotation

Comentários

getBookmarkRange(name)

Obtém o intervalo de um indicador. Gera um ItemNotFound erro se o indicador não existir.

getBookmarkRange(name: string): Word.Range;

Parâmetros

name: string

O nome do indicador que não diferencia maiúsculas de minúsculas.

Retornos

Word.Range

Comentários

getBookmarkRangeOrNullObject(name)

Obtém o intervalo de um indicador. Se o indicador não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getBookmarkRangeOrNullObject(name: string): Word.Range;

Parâmetros

name: string

O nome do indicador que não diferencia maiúsculas de minúsculas.

Retornos

Word.Range

Comentários

getContentControls(options)

Obtém os controles de conteúdo com suporte no momento no documento.

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

Parâmetros

options: Word.ContentControlOptions

Opcional. Opções que definem quais controles de conteúdo são retornados.

Retornos

Word.ContentControlCollection

Comentários

Importante: se tipos específicos forem fornecidos no parâmetro options, somente os controles de conteúdo dos tipos com suporte serão retornados. Esteja ciente de que uma exceção será lançada usando métodos de um Word genérico. ContentControl que não são relevantes para o tipo específico. Com o tempo, outros tipos de controles de conteúdo podem ser suportados. Portanto, seu suplemento deve solicitar e manipular tipos específicos de controles de conteúdo.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-checkbox-content-control.yaml

// Toggles the isChecked property on all checkbox content controls.
await Word.run(async (context) => {
  let contentControls = context.document.getContentControls({
    types: [Word.ContentControlType.checkBox]
  });
  contentControls.load("items");

  await context.sync();

  const length = contentControls.items.length;
  console.log(`Number of checkbox content controls: ${length}`);

  if (length <= 0) {
    return;
  }

  const checkboxContentControls = [];
  for (let i = 0; i < length; i++) {
    let contentControl = contentControls.items[i];
    contentControl.load("id,checkboxContentControl/isChecked");
    checkboxContentControls.push(contentControl);
  }

  await context.sync();

  console.log("isChecked state before:");
  const updatedCheckboxContentControls = [];
  for (let i = 0; i < checkboxContentControls.length; i++) {
    const currentCheckboxContentControl = checkboxContentControls[i];
    const isCheckedBefore = currentCheckboxContentControl.checkboxContentControl.isChecked;
    console.log(`id: ${currentCheckboxContentControl.id} ... isChecked: ${isCheckedBefore}`);

    currentCheckboxContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
    currentCheckboxContentControl.load("id,checkboxContentControl/isChecked");
    updatedCheckboxContentControls.push(currentCheckboxContentControl);
  }

  await context.sync();

  console.log("isChecked state after:");
  for (let i = 0; i < updatedCheckboxContentControls.length; i++) {
    const currentCheckboxContentControl = updatedCheckboxContentControls[i];
    console.log(
      `id: ${currentCheckboxContentControl.id} ... isChecked: ${currentCheckboxContentControl.checkboxContentControl.isChecked}`
    );
  }
});

getCrossReferenceItems(referenceType)

Retorna uma matriz de itens que pode ser baseada em referência cruzada no tipo de referência cruzada especificada.

getCrossReferenceItems(referenceType: Word.ReferenceType): OfficeExtension.ClientResult<string[]>;

Parâmetros

referenceType: Word.ReferenceType

O tipo de referência.

Retornos

Comentários

getCrossReferenceItems(referenceType)

Retorna uma matriz de itens que pode ser baseada em referência cruzada no tipo de referência cruzada especificada.

getCrossReferenceItems(referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"): OfficeExtension.ClientResult<string[]>;

Parâmetros

referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"

O tipo de referência.

Retornos

Comentários

getEndnoteBody()

Obtém as notas de fim do documento em um único corpo.

getEndnoteBody(): Word.Body;

Retornos

Word.Body

Comentários

getFootnoteBody()

Obtém as notas de rodapé do documento em um único corpo.

getFootnoteBody(): Word.Body;

Retornos

Word.Body

Comentários

getParagraphByUniqueLocalId(id)

Obtém o parágrafo por sua ID local exclusiva. Lançará um ItemNotFound erro se a coleção estiver vazia.

getParagraphByUniqueLocalId(id: string): Word.Paragraph;

Parâmetros

id: string

ID local exclusiva no formato GUID padrão 8-4-4-4-12 sem chaves. Observe que a ID difere entre sessões e coautores.

Retornos

Word.Paragraph

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

await Word.run(async (context) => {
  const paragraphId = (document.getElementById("paragraph-id") as HTMLInputElement).value;
  const paragraph: Word.Paragraph = context.document.getParagraphByUniqueLocalId(paragraphId);
  paragraph.load();
  await paragraph.context.sync();

  console.log(paragraph);
});

getRange(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna um Range objeto usando as posições de caractere iniciais e finais especificadas.

getRange(options?: Word.DocumentRangeOptions): Word.Range;

Parâmetros

options: Word.DocumentRangeOptions

Opcional. Opções de configuração para especificar os parâmetros de intervalo.

Retornos

Word.Range

Comentários

getSelection()

Obtém a seleção atual do documento. Não há suporte para várias seleções.

getSelection(): Word.Range;

Retornos

Word.Range

Comentários

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    const textSample = 'This is an example of the insert text method. This is a method ' + 
        'which allows users to insert text into a selection. It can insert text into a ' +
        'relative location or it can overwrite the current selection. Since the ' +
        'getSelection method returns a range object, look up the range object documentation ' +
        'for everything you can do with a selection.';
    
    // Create a range proxy object for the current selection.
    const range = context.document.getSelection();
    
    // Queue a command to insert text at the end of the selection.
    range.insertText(textSample, Word.InsertLocation.end);
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted the text at the end of the selection.');
});

getStyles()

Obtém um StyleCollection objeto que representa todo o conjunto de estilos do documento.

getStyles(): Word.StyleCollection;

Retornos

Word.StyleCollection

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Gets the number of available styles stored with the document.
await Word.run(async (context) => {
  const styles: Word.StyleCollection = context.document.getStyles();
  const count = styles.getCount();
  await context.sync();

  console.log(`Number of styles: ${count.value}`);
});

goTo(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Retorna um Range objeto que representa a posição inicial do item especificado, como uma página, um indicador ou um campo.

goTo(options?: Word.GoToOptions): Word.Range;

Parâmetros

options: Word.GoToOptions

Opcional. Opções de configuração para especificar os goTo parâmetros.

Retornos

Word.Range

Comentários

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

Importe estilos de uma cadeia de caracteres formatada em JSON.

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;

Parâmetros

stylesJson: string

Uma cadeia de caracteres formatada em JSON que representa os estilos.

importedStylesConflictBehavior: Word.ImportedStylesConflictBehavior

Opcional. Especifica como lidar com todos os estilos importados com o mesmo nome dos estilos existentes no documento atual. O valor padrão é ignore.

Retornos

Comentários

Observação: O parâmetro foi introduzido importedStylesConflictBehavior no WordApiDesktop 1.1.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml

// Imports styles from JSON.
await Word.run(async (context) => {
  const str =
    '{"styles":[{"baseStyle":"Default Paragraph Font","builtIn":false,"inUse":true,"linked":false,"nameLocal":"NewCharStyle","priority":2,"quickStyle":true,"type":"Character","unhideWhenUsed":false,"visibility":false,"paragraphFormat":null,"font":{"name":"DengXian Light","size":16.0,"bold":true,"italic":false,"color":"#F1A983","underline":"None","subscript":false,"superscript":true,"strikeThrough":true,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#FF0000"}},{"baseStyle":"Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewParaStyle","nameLocal":"NewParaStyle","priority":1,"quickStyle":true,"type":"Paragraph","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Centered","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":72.0,"lineSpacing":18.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":72.0,"spaceAfter":30.0,"spaceBefore":30.0,"widowControl":true},"font":{"name":"DengXian","size":14.0,"bold":true,"italic":true,"color":"#8DD873","underline":"Single","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":true,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#00FF00"}},{"baseStyle":"Table Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewTableStyle","nameLocal":"NewTableStyle","priority":100,"type":"Table","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Left","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":0.0,"lineSpacing":12.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":0.0,"spaceAfter":0.0,"spaceBefore":0.0,"widowControl":true},"font":{"name":"DengXian","size":20.0,"bold":false,"italic":true,"color":"#D86DCB","underline":"None","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"tableStyle":{"allowBreakAcrossPage":true,"alignment":"Left","bottomCellMargin":0.0,"leftCellMargin":0.08,"rightCellMargin":0.08,"topCellMargin":0.0,"cellSpacing":0.0},"shading":{"backgroundPatternColor":"#60CAF3"}}]}';
  const styles = context.document.importStylesFromJson(str);

  // If you'd like to set how conflicting styles are handled, use the importedStylesConflictBehavior parameter that was introduced in the Desktop 1.1 requirement set. "Ignore" is the default.
  ////const styles = context.document.importStylesFromJson(str, Word.ImportedStylesConflictBehavior.Ignore);

  await context.sync();
  console.log("Styles imported from JSON:", styles);
});

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

Importe estilos de uma cadeia de caracteres formatada em JSON.

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult<string[]>;

Parâmetros

stylesJson: string

Uma cadeia de caracteres formatada em JSON que representa os estilos.

importedStylesConflictBehavior: "Ignore" | "Overwrite" | "CreateNew"

Opcional. Especifica como lidar com todos os estilos importados com o mesmo nome dos estilos existentes no documento atual. O valor padrão é ignore.

Retornos

Comentários

Observação: O parâmetro foi introduzido importedStylesConflictBehavior no WordApiDesktop 1.1.

insertFileFromBase64(base64File, insertLocation, insertFileOptions)

Insere um documento no documento de destino em um local específico com propriedades adicionais. Cabeçalhos, rodapés, marcas d'água e outras propriedades de seção são copiadas por padrão.

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;

Parâmetros

base64File: string

O conteúdo codificado em Base64 de um arquivo .docx.

insertLocation: replace | start | end | "Replace" | "Start" | "End"

O valor deve ser replace, start, ou end.

insertFileOptions: Word.InsertFileOptions

Opcional. As propriedades adicionais que devem ser importadas para o documento de destino.

Retornos

Word.SectionCollection

Comentários

Não há suporte para a inserção se o documento que está sendo inserido contiver um controle ActiveX (provavelmente em um campo de formulário). Considere substituir esse campo de formulário por um controle de conteúdo ou outra opção apropriada para seu cenário.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml

// Inserts content (applying selected settings) from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
  // Use the Base64-encoded string representation of the selected .docx file.
  context.document.insertFileFromBase64(externalDocument, "Replace", {
    importTheme: true,
    importStyles: true,
    importParagraphSpacing: true,
    importPageColor: true,
    importChangeTrackingMode: true,
    importCustomProperties: true,
    importCustomXmlParts: true,
    importDifferentOddEvenPages: true
  });
  await context.sync();
});

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document;

Parâmetros

options: Word.Interfaces.DocumentLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Word.Document

Exemplos

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;
    
    // Queue a command to load content control properties.
    thisDocument.load('contentControls/id, contentControls/text, contentControls/tag');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (thisDocument.contentControls.items.length !== 0) {
        for (let i = 0; i < thisDocument.contentControls.items.length; i++) {
            console.log(thisDocument.contentControls.items[i].id);
            console.log(thisDocument.contentControls.items[i].text);
            console.log(thisDocument.contentControls.items[i].tag);
        }
    } else {
        console.log('No content controls in this document.');
    }
});

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Word.Document;

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

Word.Document

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Document;

Parâmetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.Document

lockServerFile()

Bloqueia o arquivo no servidor, impedindo que outro usuário realize a edição.

lockServerFile(): void;

Retornos

void

Comentários

makeCompatibilityDefault()

Define as opções de compatibilidade.

makeCompatibilityDefault(): void;

Retornos

void

Comentários

manualHyphenation()

Inicializa a hifenização manual de um documento, uma linha de cada vez.

manualHyphenation(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

merge(fileName, options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Mescla as alterações marcadas com marcas de revisão de um documento para outro.

merge(fileName: string, options?: Word.DocumentMergeOptions): void;

Parâmetros

fileName: string

O nome do arquivo a ser mesclado.

options: Word.DocumentMergeOptions

Opcional. Opções de configuração para a operação de mesclagem.

Retornos

void

Comentários

post()

Posta o documento em uma pasta pública no Microsoft Exchange.

post(): void;

Retornos

void

Comentários

presentIt()

Abre o PowerPoint com o documento do Word carregado.

presentIt(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

printOut(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Imprime todo o documento ou parte dele.

printOut(options?: Word.DocumentPrintOutOptions): void;

Parâmetros

options: Word.DocumentPrintOutOptions

Opcional. Opções de configuração para a operação de impressão.

Retornos

void

Comentários

printPreview()

Alterna para o modo de visualização de impressão.

printPreview(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

protect(type, options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Protege o documento contra alterações não autorizadas.

protect(type: Word.ProtectionType, options?: Word.DocumentProtectOptions): void;

Parâmetros

type: Word.ProtectionType

O tipo de proteção.

options: Word.DocumentProtectOptions

Opcional. Opções de configuração para proteção de documentos.

Retornos

void

Comentários

protect(type, options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Protege o documento contra alterações não autorizadas.

protect(type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading", options?: Word.DocumentProtectOptions): void;

Parâmetros

type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"

O tipo de proteção.

options: Word.DocumentProtectOptions

Opcional. Opções de configuração para proteção de documentos.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

redo(times)

Refaz a última ação que foi desfeita (inverte o undo método).

redo(times?: number): OfficeExtension.ClientResult<boolean>;

Parâmetros

times: number

Opcional. O número de ações a serem refeitas.

Retornos

OfficeExtension.ClientResult<boolean>

true Se as ações foram refeitas com êxito; caso contrário, false.

Comentários

rejectAllRevisions()

Rejeita todas as alterações controladas no documento.

rejectAllRevisions(): void;

Retornos

void

Comentários

rejectAllRevisionsShown()

Rejeita todas as revisões no documento exibidas na tela.

rejectAllRevisionsShown(): void;

Retornos

void

Comentários

reload()

Recarrega um documento armazenado no cache resolvendo o hiperlink para o documento e baixando-o.

reload(): void;

Retornos

void

Comentários

reloadAs(encoding)

Recarrega o documento com base em um documento HTML, usando a codificação do documento.

reloadAs(encoding: Word.DocumentEncoding): void;

Parâmetros

encoding: Word.DocumentEncoding

A codificação a ser usada.

Retornos

void

Comentários

reloadAs(encoding)

Recarrega o documento com base em um documento HTML, usando a codificação do documento.

reloadAs(encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"): void;

Parâmetros

encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"

A codificação a ser usada.

Retornos

void

Comentários

removeDocumentInformation(removeDocInfoType)

Remove informações confidenciais, propriedades, comentários e outros metadados do documento.

removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void;

Parâmetros

removeDocInfoType: Word.RemoveDocInfoType

O tipo de informação do documento a ser removida.

Retornos

void

Comentários

removeDocumentInformation(removeDocInfoType)

Remove informações confidenciais, propriedades, comentários e outros metadados do documento.

removeDocumentInformation(removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"): void;

Parâmetros

removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"

O tipo de informação do documento a ser removida.

Retornos

void

Comentários

removeLockedStyles()

Limpa o documento de estilos bloqueados quando restrições de formatação foram aplicadas no documento.

removeLockedStyles(): void;

Retornos

void

Comentários

removeNumbers(numberType)

Remove números ou marcadores do documento.

removeNumbers(numberType?: Word.NumberType): void;

Parâmetros

numberType: Word.NumberType

Opcional. O tipo de numeração a ser removido.

Retornos

void

Comentários

removeNumbers(numberType)

Remove números ou marcadores do documento.

removeNumbers(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

Parâmetros

numberType: "Paragraph" | "ListNum" | "AllNumbers"

Opcional. O tipo de numeração a ser removido.

Retornos

void

Comentários

removeTheme()

Remove o tema ativo do documento atual.

removeTheme(): void;

Retornos

void

Comentários

repaginate()

Repagina todo o documento.

repaginate(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

replyWithChanges(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Envia uma mensagem de email ao autor do documento que foi enviado para revisão, notificando-o de que um revisor concluiu a revisão do documento.

replyWithChanges(options?: Word.DocumentReplyWithChangesOptions): void;

Parâmetros

options: Word.DocumentReplyWithChangesOptions

Opcional. Opções de configuração para responder com alterações.

Retornos

void

Comentários

resetFormFields()

Limpa todos os campos do formulário no documento, preparando o formulário a ser preenchido novamente.

resetFormFields(): void;

Retornos

void

Comentários

returnToLastReadPosition()

Retorna o documento para a última posição de leitura salva.

returnToLastReadPosition(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

runAutoMacro(autoMacro)

Executa uma macro automática que é armazenada no documento. Se a macro automática especificada não existir, nada acontecerá.

runAutoMacro(autoMacro: Word.AutoMacro): void;

Parâmetros

autoMacro: Word.AutoMacro

A macro automática a ser executada.

Retornos

void

Comentários

runAutoMacro(autoMacro)

Executa uma macro automática que é armazenada no documento. Se a macro automática especificada não existir, nada acontecerá.

runAutoMacro(autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"): void;

Parâmetros

autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"

A macro automática a ser executada.

Retornos

void

Comentários

save(saveBehavior, fileName)

Salva o documento.

save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;

Parâmetros

saveBehavior: Word.SaveBehavior

Opcional. O comportamento de salvamento deve ser save ou prompt. O valor padrão é save.

fileName: string

Opcional. O nome do arquivo (extensão de arquivo de exclusão). Entra em vigor somente para um novo documento.

Retornos

void

Comentários

Observação: os saveBehavior parâmetros and fileName foram introduzidos no WordApi 1.5.

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Saves the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.save();
  await context.sync();
});

save(saveBehavior, fileName)

Salva o documento.

save(saveBehavior?: "Save" | "Prompt", fileName?: string): void;

Parâmetros

saveBehavior: "Save" | "Prompt"

Opcional. O comportamento de salvamento deve ser save ou prompt. O valor padrão é save.

fileName: string

Opcional. O nome do arquivo (extensão de arquivo de exclusão). Entra em vigor somente para um novo documento.

Retornos

void

Comentários

Observação: os saveBehavior parâmetros and fileName foram introduzidos no WordApi 1.5.

saveAsQuickStyleSet(fileName)

Salva o grupo de estilos rápidos atualmente em uso.

saveAsQuickStyleSet(fileName: string): void;

Parâmetros

fileName: string

O nome do arquivo a ser salvo.

Retornos

void

Comentários

search(searchText, searchOptions)

Executa uma pesquisa com as opções de pesquisa especificadas no escopo do documento inteiro. Os resultados da pesquisa são uma coleção de Range objetos.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Parâmetros

searchText: string

O texto a ser pesquisado.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Opcional. Opções que definem como a pesquisa é realizada.

Retornos

Word.RangeCollection

Comentários

select()

Seleciona o conteúdo do documento.

select(): void;

Retornos

void

Comentários

selectContentControlsByTag(tag)

Retorna todos os controles de conteúdo com a marca especificada.

selectContentControlsByTag(tag: string): Word.ContentControlCollection;

Parâmetros

tag: string

O valor da marca para filtrar os controles de conteúdo.

Retornos

Word.ContentControlCollection

Comentários

selectContentControlsByTitle(title)

Retorna um ContentControlCollection objeto que representa todos os controles de conteúdo no documento com o título especificado.

selectContentControlsByTitle(title: string): Word.ContentControlCollection;

Parâmetros

title: string

O título dos controles de conteúdo.

Retornos

Word.ContentControlCollection

Comentários

selectLinkedControls(node)

Retorna um ContentControlCollection objeto que representa todos os controles de conteúdo no documento que estão vinculados ao nó XML personalizado específico.

selectLinkedControls(node: Word.CustomXmlNode): Word.ContentControlCollection;

Parâmetros

node: Word.CustomXmlNode

O nó XML personalizado.

Retornos

Word.ContentControlCollection

Comentários

selectNodes(xPath, options)

Retorna um XmlNodeCollection objeto que representa todos os nós que correspondem ao parâmetro XPath na ordem em que aparecem no documento.

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

Parâmetros

xPath: string

A expressão XPath.

options: Word.SelectNodesOptions

Opcional. Opções de configuração para a seleção de nós.

Retornos

Word.XmlNodeCollection

Comentários

selectSingleNode(xPath, options)

Retorna um XmlNode objeto que representa o primeiro nó que corresponde ao parâmetro XPath no documento.

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

Parâmetros

xPath: string

A expressão XPath.

options: Word.SelectSingleNodeOptions

Opcional. Opções de configuração para a seleção de nó.

Retornos

Word.XmlNode

Comentários

selectUnlinkedControls(stream)

Retorna um ContentControlCollection objeto que representa todos os controles de conteúdo no documento que não estão vinculados a um nó XML.

selectUnlinkedControls(stream?: Word.CustomXmlPart): Word.ContentControlCollection;

Parâmetros

stream: Word.CustomXmlPart

Opcional. A parte XML personalizada.

Retornos

Word.ContentControlCollection

Comentários

sendFax(address, subject)

Envia o documento como um fax, sem nenhuma interação do usuário.

sendFax(address: string, subject?: string): void;

Parâmetros

address: string

O endereço de fax.

subject: string

Opcional. O assunto do fax.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

sendFaxOverInternet(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Envia o documento para um provedor de serviços de fax, que o envia por fax para um ou mais destinatários especificados.

sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions): void;

Parâmetros

options: Word.DocumentSendFaxOverInternetOptions

Opcional. Opções de configuração para enviar o fax pela Internet.

Retornos

void

Comentários

sendForReview(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Envia o documento em uma mensagem de email para revisão pelos destinatários especificados.

sendForReview(options?: Word.DocumentSendForReviewOptions): void;

Parâmetros

options: Word.DocumentSendForReviewOptions

Opcional. Opções de configuração para enviar o documento para revisão.

Retornos

void

Comentários

Conjunto de APIs: WordApi BETA (SOMENTE VISUALIZAÇÃO)

sendMail()

Abre uma janela de mensagem para enviar o documento pelo Microsoft Exchange.

sendMail(): void;

Retornos

void

Comentários

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.DocumentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Word.Interfaces.DocumentUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.Document): void;

Parâmetros

properties: Word.Document

Retornos

void

setDefaultTableStyle(style, setInTemplate)

Especifica o estilo de tabela a ser usado para tabelas recém-criadas no documento.

setDefaultTableStyle(style: string, setInTemplate: boolean): void;

Parâmetros

style: string

O estilo a ser aplicado.

setInTemplate: boolean

Se deseja definir o estilo no modelo.

Retornos

void

Comentários

setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)

Define as opções que o Microsoft Word usa para criptografar documentos com senhas.

setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean): void;

Parâmetros

passwordEncryptionProvider: string

O provedor de criptografia.

passwordEncryptionAlgorithm: string

O algoritmo de criptografia.

passwordEncryptionKeyLength: number

O comprimento da chave.

passwordEncryptFileProperties: boolean

Opcional. Se deseja criptografar propriedades de arquivo.

Retornos

void

Comentários

toggleFormsDesign()

Ativa ou desativa o modo de design do formulário .

toggleFormsDesign(): void;

Retornos

void

Comentários

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.Document é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.DocumentData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.DocumentData;

Retornos

Word.Interfaces.DocumentData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.Document;

Retornos

Word.Document

transformDocument(path, dataOnly)

Aplica o arquivo XSLT (Extensible Stylesheet Language Transformation) especificado a esse documento e substitui o documento pelos resultados.

transformDocument(path: string, dataOnly?: boolean): void;

Parâmetros

path: string

O caminho para o arquivo XSLT.

dataOnly: boolean

Opcional. Se deseja usar apenas dados.

Retornos

void

Comentários

undo(times)

Desfaz a última ação ou sequência de ações, exibidas na lista Desfazer.

undo(times?: number): OfficeExtension.ClientResult<boolean>;

Parâmetros

times: number

Opcional. O número de ações a serem desfeitas.

Retornos

OfficeExtension.ClientResult<boolean>

true Se as ações foram desfeitas com êxito; caso contrário, false.

Comentários

undoClear()

Limpa a lista de ações que podem ser desfeitas no documento.

undoClear(): void;

Retornos

void

Comentários

unprotect(password)

Remove a proteção do documento.

unprotect(password?: string): void;

Parâmetros

password: string

Opcional. A senha para desproteger o documento.

Retornos

void

Comentários

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.Document;

Retornos

Word.Document

updateStyles()

Copia todos os estilos do modelo anexado para o documento, sobrescrevendo quaisquer estilos existentes no documento que tenham o mesmo nome.

updateStyles(): void;

Retornos

void

Comentários

viewCode()

Exibe a janela de código para o controle ActiveX da Microsoft selecionado no documento.

viewCode(): void;

Retornos

void

Comentários

viewPropertyBrowser()

Exibe a janela de propriedades do controle ActiveX da Microsoft selecionado no documento.

viewPropertyBrowser(): void;

Retornos

void

Comentários

webPagePreview()

Exibe uma visualização do documento atual como ele ficaria se fosse salvo como uma página da Web.

webPagePreview(): void;

Retornos

void

Comentários

OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>

onAnnotationClicked

Ocorre quando o usuário clica em uma anotação (ou a seleciona usando Alt+Down).

readonly onAnnotationClicked: OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>;

Tipo de evento

Comentários

OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onClickedHandler(args: Word.AnnotationClickedEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationClicked: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

onAnnotationHovered

Ocorre quando o usuário passa o cursor sobre uma anotação.

readonly onAnnotationHovered: OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>;

Tipo de evento

Comentários

OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onHoveredHandler(args: Word.AnnotationHoveredEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationHovered: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

onAnnotationInserted

Ocorre quando o usuário adiciona uma ou mais anotações.

readonly onAnnotationInserted: OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>;

Tipo de evento

Comentários

OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onInsertedHandler(args: Word.AnnotationInsertedEventArgs) {
  await Word.run(async (context) => {
    const annotations = [];
    for (let i = 0; i < args.ids.length; i++) {
      let annotation: Word.Annotation = context.document.getAnnotationById(args.ids[i]);
      annotation.load("id,critiqueAnnotation");

      annotations.push(annotation);
    }

    await context.sync();

    for (let annotation of annotations) {
      console.log(`AnnotationInserted: ID ${annotation.id}:`, annotation.critiqueAnnotation.critique);
    }
  });
}

onAnnotationPopupAction

Ocorre quando o usuário executa uma ação em um menu pop-up de anotação.

readonly onAnnotationPopupAction: OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>;

Tipo de evento

Comentários

Conjunto de APIs: WordApi 1.8

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onPopupActionHandler(args: Word.AnnotationPopupActionEventArgs) {
  await Word.run(async (context) => {
    let message = `AnnotationPopupAction: ID ${args.id} = `;
    if (args.action === "Accept") {
      message += `Accepted: ${args.critiqueSuggestion}`;
    } else {
      message += "Rejected";
    }

    console.log(message);
  });
}

onAnnotationRemoved

Ocorre quando o usuário exclui uma ou mais anotações.

readonly onAnnotationRemoved: OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>

Comentários

OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onRemovedHandler(args: Word.AnnotationRemovedEventArgs) {
  await Word.run(async (context) => {
    for (let id of args.ids) {
      console.log(`AnnotationRemoved: ID ${id}`);
    }
  });
}

onContentControlAdded

Ocorre quando um controle de conteúdo é adicionado. Execute context.sync() no manipulador para obter as propriedades do novo controle de conteúdo.

readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>;

Tipo de evento

Comentários

OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/content-control-onadded-event.yaml

// Registers the onAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onContentControlAdded.add(contentControlAdded);
  await context.sync();

  console.log("Added event handler for when content controls are added.");
});

...

async function contentControlAdded(event: Word.ContentControlAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls that were added:`, event.ids);
  });
}

onParagraphAdded

Ocorre quando o usuário adiciona novos parágrafos.

readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;

Tipo de evento

Comentários

OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

// Registers the onParagraphAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphAdded.add(paragraphAdded);
  await context.sync();

  console.log("Added event handler for when paragraphs are added.");
});

...

async function paragraphAdded(event: Word.ParagraphAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs that were added:`, event.uniqueLocalIds);
  });
}

onParagraphChanged

Ocorre quando o usuário altera parágrafos.

readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;

Tipo de evento

Comentários

OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onchanged-event.yaml

// Registers the onParagraphChanged event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphChanged.add(paragraphChanged);
  await context.sync();

  console.log("Added event handler for when content is changed in paragraphs.");
});

...

async function paragraphChanged(event: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs where content was changed:`, event.uniqueLocalIds);
  });
}

onParagraphDeleted

Ocorre quando o usuário exclui parágrafos.

readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;

Tipo de evento

Comentários