Word. Document class

Propriedades

body	Obtém o objeto body do documento main. O corpo é o texto que exclui cabeçalhos, rodapés, notas de rodapé, caixas de texto etc.
changeTrackingMode	Especifica o modo ChangeTracking.
contentControls	Obtém a coleção de objetos de controle de conteúdo 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.
customXmlParts	Obtém as partes XML personalizadas no documento.
properties	Obtém as propriedades do documento.
saved	Indica se as alterações do documento foram salvas. Um valor true indica que o documento não foi alterado desde que foi salvo.
sections	Obtém a coleção de objetos de seção no documento.
settings	Obtém as configurações do suplemento no documento.

Métodos

addStyle(name, type)	Adiciona um estilo ao documento por nome e tipo.
addStyle(name, typeString)	Adiciona um estilo ao documento por nome e tipo.
close(closeBehavior)	Fecha o documento atual.
close(closeBehaviorString)	Fecha o documento atual.
compare(filePath, documentCompareOptions)	Exibe marcas de revisão que indicam onde o documento especificado difere de um outro documento.
deleteBookmark(name)	Exclui um indicador, se ele existir, do documento.
getAnnotationById(id)	Obtém a anotação por ID. Gerará um `ItemNotFound` erro se a anotação não for encontrada.
getBookmarkRange(name)	Obtém o intervalo de um indicador. Gerará 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.
getEndnoteBody()	Obtém as notas de extremidade 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. Gerará um `ItemNotFound` erro se a coleção estiver vazia.
getSelection()	Obtém a seleção atual do documento. Não há suporte para várias seleções.
getStyles()	Obtém um objeto StyleCollection que representa todo o conjunto de estilos do documento.
importStylesFromJson(stylesJson)	Importar estilos de uma cadeia de caracteres formatada por 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 copiados 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.
save(saveBehavior, fileName)	Salva o documento.
save(saveBehaviorString, fileName)	Salva o documento.
search(searchText, searchOptions)	Executa uma pesquisa com as opções de pesquisa especificadas no escopo de todo o documento. Os resultados da pesquisa são uma coleção de objetos Range.
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.
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 Word original. Objeto document é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Word.Interfaces.DocumentData`) que contém cópias rasas de quaisquer 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 para 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, você 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.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para 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á chamar `context.sync()` antes que a versão da memória entre em vigor.

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.

Detalhes da propriedade

body

Obtém o objeto body do documento main. 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

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 = 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.");
  }
});

contentControls

Obtém a coleção de objetos de controle de conteúdo 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

customXmlParts

Obtém as partes XML personalizadas no documento.

readonly customXmlParts: Word.CustomXmlPartCollection;

Valor da propriedade

Word.CustomXmlPartCollection

Comentários

properties

Obtém as propriedades do documento.

readonly properties: Word.DocumentProperties;

Valor da propriedade

Word.DocumentProperties

Comentários

[ Conjunto de API: WordApi 1.3 ]

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 = context.document.properties;
    builtInProperties.load("*"); // Let's get all!

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

saved

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

readonly saved: boolean;

Valor da propriedade

boolean

Comentários

sections

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

readonly sections: Word.SectionCollection;

Valor da propriedade

Word.SectionCollection

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 = 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]);
    }
  }
});

Detalhes do método

addStyle(name, type)

Adiciona um estilo ao documento por nome e tipo.

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

Parâmetros

name: string

Obrigatório. Uma cadeia de caracteres que representa o nome do estilo.

type: Word.StyleType

Obrigatório. 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 = $("#new-style-name").val() as string;
  if (newStyleName == "") {
    console.warn("Enter a style name to add.");
    return;
  }

  const 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 = ($("#new-style-type").val() 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, typeString)

Adiciona um estilo ao documento por nome e tipo.

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

Parâmetros

name: string

Obrigatório. Uma cadeia de caracteres que representa o nome do estilo.

typeString: "Character" | "List" | "Paragraph" | "Table"

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

Retornos

Word.Style

Comentários

close(closeBehavior)

Fecha o documento atual.

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

Parâmetros

closeBehavior: Word.CloseBehavior

Opcional. O comportamento próximo deve ser 'Salvar' ou 'SkipSave'. O valor padrão é 'Salvar'.

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(closeBehaviorString)

Fecha o documento atual.

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

Parâmetros

closeBehaviorString: "Save" | "SkipSave"

Opcional. O comportamento próximo deve ser 'Salvar' ou 'SkipSave'. O valor padrão é 'Salvar'.

Retornos

void

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

compare(filePath, documentCompareOptions)

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 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

Obrigatório. O caminho do documento com o qual o documento especificado é comparado.

documentCompareOptions: Word.DocumentCompareOptions

Opcional. As opções adicionais que especificam o comportamento da comparação do documento.

Retornos

void

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/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 = $("#filePath")
    .val()
    .toString();
  // Options that configure the compare operation.
  const options = {
    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.");
});

deleteBookmark(name)

Exclui um indicador, se ele existir, do documento.

deleteBookmark(name: string): void;

Parâmetros

name: string

Obrigatório. O nome do indicador insensibilidade de maiúsculas de maiúsculas de minúsculas.

Retornos

void

Comentários

getAnnotationById(id)

Obtém a anotação por ID. Gerará 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 obtido.

Retornos

Word.Annotation

Comentários

getBookmarkRange(name)

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

getBookmarkRange(name: string): Word.Range;

Parâmetros

name: string

Obrigatório. O nome do indicador insensibilidade de maiúsculas de 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

Obrigatório. O nome do indicador insensibilidade de maiúsculas de 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 de opções, somente os controles de conteúdo dos tipos com suporte serão retornados. Lembre-se de que uma exceção será gerada no uso de métodos de uma Word genérica. ContentControl que não são relevantes para o tipo específico. Com o tempo, podem ser suportados tipos adicionais de controles de conteúdo. 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}`
    );
  }
});

getEndnoteBody()

Obtém as notas de extremidade 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. Gerará um ItemNotFound erro se a coleção estiver vazia.

getParagraphByUniqueLocalId(id: string): Word.Paragraph;

Parâmetros

id: string

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

Retornos

Word.Paragraph

Comentários

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 = $("#paragraph-id").val() as string;
  const paragraph = context.document.getParagraphByUniqueLocalId(paragraphId);
  paragraph.load();
  await paragraph.context.sync();

  console.log(paragraph);
});

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 objeto StyleCollection que representa todo o conjunto de estilos do documento.

getStyles(): Word.StyleCollection;

Retornos

Word.StyleCollection

Comentários

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 styles.
await Word.run(async (context) => {
  const styles = context.document.getStyles();
  const count = styles.getCount();
  await context.sync();

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

importStylesFromJson(stylesJson)

Importar estilos de uma cadeia de caracteres formatada por JSON.

importStylesFromJson(stylesJson: string): OfficeExtension.ClientResult<string[]>;

Parâmetros

stylesJson: string

Obrigatório. Uma cadeia de caracteres formatada por JSON que representa os estilos.

Retornos

OfficeExtension.ClientResult<string[]>

Comentários

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/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);
  await context.sync();
  console.log("Styles imported from JSON:", styles);
});

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 copiados 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

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

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

Obrigatório. 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

Observação: não há suporte para inserção se o documento 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 carregar.

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írgulas ou uma matriz de cadeias de caracteres que especificam 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írgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.Document

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 'Salvar' ou 'Prompt'. O valor padrão é 'Salvar'.

fileName: string

Opcional. O nome do arquivo (excluir extensão de arquivo). Só entra em vigor para um novo documento.

Retornos

void

Comentários

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

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 the document save state (on the saved property).
    thisDocument.load('saved');    
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (thisDocument.saved === false) {
        // Queue a command to save this document.
        thisDocument.save();
        
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Saved the document');
    } else {
        console.log('The document has not changed since the last save.');
    }
});

// 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(saveBehaviorString, fileName)

Salva o documento.

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

Parâmetros

saveBehaviorString: "Save" | "Prompt"

Opcional. O comportamento de salvamento deve ser 'Salvar' ou 'Prompt'. O valor padrão é 'Salvar'.

fileName: string

Opcional. O nome do arquivo (excluir extensão de arquivo). Só entra em vigor para um novo documento.

Retornos

void

Comentários

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

search(searchText, searchOptions)

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

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

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

Retornos

Word.RangeCollection

Comentários

OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>

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 properties tentar definir quaisquer 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

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. Objeto document é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.DocumentData) que contém cópias rasas de quaisquer 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 para 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, você 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

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para 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á chamar context.sync() antes que a versão da memória entre em vigor.

untrack(): Word.Document;

Retornos

Word.Document

Detalhes do evento

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>

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>

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>

onAnnotationPopupAction

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.

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 API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

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>

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