Word.Document class

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

readonly activeTheme: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o nome a apresentar do tema ativo.

readonly activeThemeDisplayName: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém a janela ativa do documento.

readonly activeWindow: Word.Window;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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

Obtém se Word encripta as propriedades do ficheiro para documentos protegidos por palavra-passe.

readonly areFilePropertiesPasswordEncrypted: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

areGrammaticalErrorsShown: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se deve utilizar as predefinições matemáticas ao criar novas equações.

areMathDefaultsUsed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se pretende desativar as funcionalidades introduzidas após uma versão especificada.

areNewerFeaturesDisabled: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se o Microsoft Word sublinha erros ortográficos no documento.

areSpellingErrorsShown: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se o Microsoft Word incorpora tipos de letra TrueType no documento quando são guardados.

areTrueTypeFontsEmbedded: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

attachedTemplate: Word.Template;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

autoHyphenation: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

autoSaveOn: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

readonly background: Word.Shape;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve um Bibliography objeto que representa as referências bibliografias contidas no documento.

readonly bibliography: Word.Bibliography;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

Comentários

[ Conjunto de API: WordApi 1.1 ]

Devolve um BookmarkCollection objeto que representa todos os marcadores no documento.

readonly bookmarks: Word.BookmarkCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém um DocumentProperties objeto que representa todas as propriedades incorporadas do documento.

readonly builtInDocumentProperties: Word.DocumentProperties;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o modo ChangeTracking.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

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

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

readonly characters: Word.RangeScopedCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém um Coauthoring objeto para gerir a cocriação no documento.

readonly coauthoring: Word.Coauthoring;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly codeName: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly comments: Word.CommentCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

consecutiveHyphensLimit: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

readonly content: Word.Range;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly contentControls: Word.ContentControlCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

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

readonly currentRsid: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly customDocumentProperties: Word.DocumentProperties;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém as partes XML personalizadas no documento.

readonly customXmlParts: Word.CustomXmlPartCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

Especifica o intervalo (em pontos) entre as tabulações predefinidas no documento.

defaultTabStop: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica a moldura do browser para apresentar uma página Web através de hiperligação.

defaultTargetFrame: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve um DocumentLibraryVersionCollection objeto que representa a coleção de versões de um documento partilhado que tem o controlo de versões ativado e que está armazenado numa biblioteca de documentos num servidor.

readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se Word não devem incorporar tipos de letra comuns do sistema.

doNotEmbedSystemFonts: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o nome do fornecedor de encriptação de algoritmos que o Microsoft Word utiliza ao encriptar documentos.

encryptionProvider: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly fields: Word.FieldCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se Word mostra o nível de cabeçalho seguinte quando o anterior é utilizado.

formattingIsNextLevelShown: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se pretende mostrar estilos definidos pelo utilizador.

formattingIsUserStyleNameShown: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve um FrameCollection objeto que representa todas as molduras no documento.

readonly frames: Word.FrameCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

readonly fullName: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém um RangeCollection objeto que representa as frases que falharam na marcar gramatical no documento.

readonly grammaticalErrors: Word.RangeCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o espaço horizontal entre linhas de grelha invisíveis que a Microsoft Word utiliza quando desenha, move e redimensiona as formas automáticas ou os carateres do leste asiático no documento.

gridDistanceHorizontal: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o espaço vertical entre linhas de grelha invisíveis que a Microsoft Word utiliza quando desenha, move e redimensiona as formas automáticas ou os carateres do leste asiático no documento.

gridDistanceVertical: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se a grelha de carateres começa no canto superior esquerdo da página.

gridIsOriginFromMargin: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o ponto de origem horizontal para a grelha invisível.

gridOriginHorizontal: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o ponto de origem vertical para a grelha invisível.

gridOriginVertical: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o intervalo para linhas de grelha de carateres horizontais na vista de esquema de impressão.

gridSpaceBetweenHorizontalLines: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o intervalo para linhas de grelha de carateres verticais na vista de esquema de impressão.

gridSpaceBetweenVerticalLines: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se é necessária uma palavra-passe para abrir o documento.

readonly hasPassword: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se o documento tem um projeto do Microsoft Visual Basic for Applications anexado.

readonly hasVbProject: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve um HyperlinkCollection objeto que representa todas as hiperligações no documento.

readonly hyperlinks: Word.HyperlinkCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

hyphenateCaps: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

hyphenationZone: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly indexes: Word.IndexCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

isAutoFormatOverrideOn: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se os gráficos no documento ativo utilizam o controlo de pontos de dados de referência de células.

isChartDataPointTracked: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

isCompatible: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se o documento é final.

isFinal: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se o Microsoft Word guarda um subconjunto dos tipos de letra TrueType incorporados com o documento.

isFontsSubsetSaved: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se a Microsoft Word imprime num formulário pré-impresso apenas os dados introduzidos no formulário online correspondente.

isFormsDataPrinted: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se o Microsoft Word guarda os dados introduzidos num formulário como um registo delimitado por tabulações para utilização numa base de dados.

isFormsDataSaved: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se uma marcar gramatical foi executada no documento.

isGrammarChecked: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se o acionamento mais recente do Application.DocumentBeforeSave evento foi o resultado de uma gravação automática pelo documento ou de uma gravação manual pelo utilizador.

readonly isInAutoSave: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se o documento está no modo de estrutura do formulário.

readonly isInFormsDesign: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se Word kerns carateres latinos de meia largura e sinais de pontuação.

isKerningByAlgorithm: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se pretende incorporar dados de voz e escrita manual.

isLinguisticDataEmbedded: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se este documento é um documento master.

readonly isMasterDocument: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se Word otimiza o documento para o Word 97.

isOptimizedForWord97: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

isPostScriptPrintedOverText: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se os utilizadores podem alterar o conjunto de Estilos Rápidos.

isQuickStyleSetLocked: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se as alterações ao documento não podem ser guardadas no documento original.

readonly isReadOnly: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se o Microsoft Word apresenta uma caixa de mensagem sempre que um utilizador abre o documento, sugerindo que seja aberto como só de leitura.

isReadOnlyRecommended: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se as formas automáticas ou os carateres do leste asiático são automaticamente alinhados com uma grelha invisível.

isSnappedToGrid: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se as formas automáticas ou os carateres do leste asiático se alinham com linhas de grelha invisíveis através de outras formas.

isSnappedToShapes: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se a ortografia foi verificada em todo o documento.

isSpellingChecked: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

isStyleEnforced: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se este documento é um subdocumento de um master documento.

readonly isSubdocument: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se os utilizadores podem alterar o tema do documento.

isThemeLocked: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se o documento foi criado ou aberto pelo utilizador.

isUserControl: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se o projeto VBA está assinado digitalmente.

readonly isVbaSigned: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém se o documento está protegido com uma palavra-passe de escrita.

readonly isWriteReserved: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o ajuste do espaçamento entre carateres.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

languageDetected: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

readonly listParagraphs: Word.ParagraphCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly lists: Word.ListCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly listTemplates: Word.ListTemplateCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

noLineBreakAfter: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

noLineBreakBefore: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém a codificação utilizada 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

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly originalDocumentTitle: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve um PageSetup objeto associado ao documento.

readonly pageSetup: Word.PageSetup;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

readonly paragraphs: Word.ParagraphCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define uma palavra-passe que tem de ser fornecida para abrir o documento.

password: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o algoritmo utilizado para a encriptação de palavras-passe.

readonly passwordEncryptionAlgorithm: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o comprimento da chave utilizado para a encriptação de palavras-passe.

readonly passwordEncryptionKeyLength: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o nome do fornecedor de encriptação de palavras-passe.

readonly passwordEncryptionProvider: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly path: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

printRevisions: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém as propriedades do documento.

readonly properties: Word.DocumentProperties;

Valor da propriedade

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

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

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

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly readabilityStatistics: Word.ReadabilityStatisticCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica a largura das páginas na vista de esquema de leitura quando são bloqueadas.

readingLayoutSizeX: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica a altura das páginas na vista de esquema de leitura quando são bloqueadas.

readingLayoutSizeY: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se as páginas na vista de esquema de leitura estão bloqueadas para marcações escritas à mão.

readingModeIsLayoutFrozen: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se Word remove as informações do utilizador ao guardar.

removePersonalInformationOnSave: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly revisedDocumentTitle: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly revisions: Word.RevisionCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly saved: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Especifica a codificação utilizada ao guardar 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

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o formato de ficheiro 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

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly sections: Word.SectionCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

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

readonly selection: Word.Selection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly sentences: Word.RangeScopedCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly settings: Word.SettingCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.4 ]

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

Obtém um RangeCollection objeto que representa as palavras identificadas como erros ortográficos no documento.

readonly spellingErrors: Word.RangeCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly storyRanges: Word.RangeCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém um StyleCollection para o documento.

readonly styles: Word.StyleCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve um TableOfAuthoritiesCategoryCollection objeto que representa as categorias de índice de autoridades disponíveis no documento.

readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly tables: Word.TableCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve um TableOfContentsCollection objeto que representa todos os índices no documento.

readonly tablesOfContents: Word.TableOfContentsCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve um TableOfFiguresCollection objeto que representa todas as tabelas de ilustrações no documento.

readonly tablesOfFigures: Word.TableOfFiguresCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica a codificação para guardar 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

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica como Word marca quebras de linha e parágrafo em ficheiros de texto.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

trackedChangesAreDateAndTimeRemoved: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

trackFormatting: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se pretende marcar o texto movido quando a opção Registar Alterações está ativada.

trackMoves: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

trackRevisions: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém o WebSettings objeto para atributos relacionados com páginas Web.

readonly webSettings: Word.WebSettings;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

readonly windows: Word.WindowCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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}`);
});

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

readonly words: Word.RangeScopedCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define uma palavra-passe para guardar as alterações ao documento.

writePassword: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

xmlAreAdvancedErrorsShown: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se pretende guardar um documento através de um XSLT (Extensible Stylesheet Language Transformation).

xmlIsXsltUsedWhenSaving: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o caminho e o nome de ficheiro do XSLT a aplicar ao guardar um documento.

xmlSaveThroughXslt: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Aceita todas as alterações registadas no documento.

acceptAllRevisions(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Aceita todas as revisões no documento que são apresentadas no ecrã.

acceptAllRevisionsShown(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Ativa o documento para que se torne o documento ativo.

activate(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Adiciona um estilo ao documento por nome e tipo.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.5 ]

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

Adiciona um estilo ao documento por nome e tipo.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.5 ]

Cria um atalho para o documento ou hiperligação e adiciona-o à pasta Favoritos .

addToFavorites(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Aplica o conjunto de Estilos Rápidos ao documento.

applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Aplica o conjunto de Estilos Rápidos ao documento.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Aplica o tema especificado a este documento.

applyTheme(name: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Formatará automaticamente o documento.

autoFormat(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve true se o Microsoft Word puder marcar no documento para um servidor.

canCheckin(): OfficeExtension.ClientResult<boolean>;

Retornos

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

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Inicia uma marcar ortográfica e gramatical para o documento.

checkGrammar(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Verifica o documento do computador local para um servidor e define o documento local como só de leitura para que não possa ser editado localmente.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Guarda o documento num servidor a partir de um computador local e define o documento local como só de leitura para que não possa ser editado localmente.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Inicia uma marcar ortográfica para o documento.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Fecha o documento atual.

Nota: esta API não é suportada no Word na Web.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.5 ]

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();
});

Fecha o documento atual.

Nota: esta API não é suportada no Word na Web.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.5 ]

Muda o documento da pré-visualização para a vista anterior.

closePrintPreview(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.1 ]

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

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

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Devolve 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

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Converte o ficheiro no formato mais recente e ativa todas as funcionalidades.

convert(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Converte hífenes automáticos em hífenes manuais.

convertAutoHyphens(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Altera os números de lista e os campos LISTNUM no documento para texto.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Altera os números de lista e os campos LISTNUM no documento para texto.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Copia estilos do modelo especificado para o documento.

copyStylesFromTemplate(StyleTemplate: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve o número de itens com marcas ou numerados e campos LISTNUM no documento.

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

Parâmetros

Retornos

A contagem de itens numerados.

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Elimina todos os comentários do documento.

deleteAllComments(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Elimina todas as revisões no documento que são apresentadas no ecrã.

deleteAllCommentsShown(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Elimina todas as anotações escritas à mão no documento.

deleteAllInkAnnotations(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Elimina um marcador, se existir, do documento.

deleteBookmark(name: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.4 ]

Analisa o texto do documento para determinar o idioma.

detectLanguage(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Termina uma revisão do ficheiro que foi enviado para revisão.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Guarda o documento no formato PDF ou XPS.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Guarda o documento no formato PDF ou XPS.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Guarda o documento no formato PDF ou XPS.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Guarda o documento no formato PDF ou XPS.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Guarda o documento no formato PDF ou XPS com etiquetas melhoradas.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Guarda o documento no formato PDF ou XPS com etiquetas melhoradas.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Diminui o tamanho do tipo de letra do texto apenas o suficiente para que a contagem de páginas do documento caia um.

fitToPages(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Corrige o esquema do documento na vista Web.

freezeLayout(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Retornos

Comentários

[ Conjunto de API: WordApi 1.7 ]

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

getBookmarkRange(name: string): Word.Range;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.4 ]

Obtém o intervalo de um marcador. Se o marcador não existir, este método devolverá um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getBookmarkRangeOrNullObject(name: string): Word.Range;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.4 ]

Obtém os controlos de conteúdo atualmente suportados no documento.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.5 ]

Importante: se forem fornecidos tipos específicos no parâmetro de opções, apenas são devolvidos controlos de conteúdo de tipos suportados. Tenha em atenção que será gerada uma exceção através de métodos de um Word genérico. ContentControl que não são relevantes para o tipo específico. Com o tempo, podem ser suportados tipos adicionais de controlos de conteúdo. Por conseguinte, o suplemento deve pedir e processar tipos específicos de controlos 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}`
    );
  }
});

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

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

getEndnoteBody(): Word.Body;

Retornos

Comentários

[ Conjunto de API: WordApi 1.5 ]

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

getFootnoteBody(): Word.Body;

Retornos

Comentários

[ Conjunto de API: WordApi 1.5 ]

Obtém o parágrafo pelo ID local exclusivo. Gera um ItemNotFound erro se a coleção estiver vazia.

getParagraphByUniqueLocalId(id: string): Word.Paragraph;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.6 ]

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

Devolve um Range objeto utilizando as posições de carateres iniciais e finais especificadas.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Obtém a seleção atual do documento. Não são suportadas múltiplas seleções.

getSelection(): Word.Range;

Retornos

Comentários

[ Conjunto de API: WordApi 1.1 ]

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

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

getStyles(): Word.StyleCollection;

Retornos

Comentários

[ Conjunto de API: WordApi 1.5 ]

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}`);
});

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Importar estilos de uma cadeia formatada em JSON.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.6 ]

Nota: o importedStylesConflictBehavior parâmetro foi introduzido 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);
});

Importar estilos de uma cadeia formatada em JSON.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.6 ]

Nota: o importedStylesConflictBehavior parâmetro foi introduzido no WordApiDesktop 1.1.

Insere um documento no documento de destino numa localização específica com propriedades adicionais. Os cabeçalhos, rodapés, marcas d'água e outras propriedades de secção são copiados por predefinição.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.5 ]

A inserção não é suportada se o documento que está a ser inserido contiver um controlo ActiveX (provavelmente num campo de formulário). Considere substituir tal campo de formulário por um controlo de conteúdo ou outra opção adequada para o 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();
});

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

Retornos

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

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

Retornos

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

Retornos

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

lockServerFile(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define as opções de compatibilidade.

makeCompatibilityDefault(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

manualHyphenation(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Publica o documento numa pasta pública no Microsoft Exchange.

post(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Abre o PowerPoint com o Word documento carregado.

presentIt(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Imprime todo ou parte do documento.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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

printPreview(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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

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

Parâmetros

Retornos

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

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Rejeita todas as alterações registadas no documento.

rejectAllRevisions(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Rejeita todas as revisões no documento que são apresentadas no ecrã.

rejectAllRevisionsShown(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

reload(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Recarrega o documento com base num documento HTML com a codificação do documento.

reloadAs(encoding: Word.DocumentEncoding): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Recarrega o documento com base num documento HTML com 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

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

removeLockedStyles(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Remove números ou marcas de lista do documento.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Remove números ou marcas de lista do documento.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Remove o tema ativo do documento atual.

removeTheme(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Repagina todo o documento.

repaginate(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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

resetFormFields(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve o documento à última posição de leitura guardada.

returnToLastReadPosition(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

runAutoMacro(autoMacro: Word.AutoMacro): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Executa uma macro automática 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

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Salva o documento.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.1 ]

Nota: 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();
});

Salva o documento.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi 1.1 ]

Nota: os saveBehavior parâmetros e fileName foram introduzidos no WordApi 1.5.

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

saveAsQuickStyleSet(fileName: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Efetua uma pesquisa com as opções de pesquisa especificadas no âmbito de todo o documento. 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

Retornos

Comentários

[ Conjunto de API: WordApi 1.7 ]

Seleciona o conteúdo do documento.

select(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve todos os controlos de conteúdo com a etiqueta especificada.

selectContentControlsByTag(tag: string): Word.ContentControlCollection;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

selectContentControlsByTitle(title: string): Word.ContentControlCollection;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve 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

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Devolve um ContentControlCollection objeto que representa todos os controlos de conteúdo no documento que não estão ligados a um nó XML.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Envia o documento como fax, sem qualquer interação do utilizador.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Envia o documento numa mensagem de e-mail para revisão pelos destinatários especificados.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Abre uma janela de mensagem para enviar o documento através do Microsoft Exchange.

sendMail(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

Retornos

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

set(properties: Word.Document): void;

Parâmetros

Retornos

Especifica o estilo de tabela a utilizar para as tabelas criadas recentemente no documento.

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

toggleFormsDesign(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Document é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.DocumentData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.DocumentData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.Document;

Retornos

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

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

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

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

Parâmetros

Retornos

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

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

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

undoClear(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Remove a proteção do documento.

unprotect(password?: string): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.Document;

Retornos

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

updateStyles(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Apresenta a janela de código do controlo Microsoft ActiveX selecionado no documento.

viewCode(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Apresenta a janela de propriedades do controlo Microsoft ActiveX selecionado no documento.

viewPropertyBrowser(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Apresenta uma pré-visualização do documento atual como seria se fosse guardado como uma página Web.

webPagePreview(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Ocorre quando o utilizador clica numa anotação (ou seleciona-a com Alt+Seta Para Baixo).

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

Tipo de evento

Comentários

[ Conjunto de API: WordApi 1.7 ]

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

Ocorre quando o utilizador paira o cursor sobre uma anotação.

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

Tipo de evento

Comentários

[ Conjunto de API: WordApi 1.7 ]

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

Ocorre quando o utilizador adiciona uma ou mais anotações.

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

Tipo de evento

Comentários

[ Conjunto de API: WordApi 1.7 ]

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

Ocorre quando o utilizador executa uma ação num menu de pop-up de anotação.

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

Tipo de evento

Comentários

[ Conjunto de API: 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);
  });
}

Ocorre quando o utilizador elimina uma ou mais anotações.

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

Tipo de evento

Comentários

[ Conjunto de API: WordApi 1.7 ]

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}`);
    }
  });
}

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

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

Tipo de evento

Comentários

[ Conjunto de API: WordApi 1.5 ]

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

Ocorre quando o utilizador adiciona novos parágrafos.

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

Tipo de evento

Comentários

[ Conjunto de API: WordApi 1.6 ]

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

Ocorre quando o utilizador altera parágrafos.

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

Tipo de evento

Comentários

[ Conjunto de API: WordApi 1.6 ]

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

Ocorre quando o utilizador elimina parágrafos.

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

Tipo de evento

Comentários

[ Conjunto de API: WordApi 1.6 ]

Exemplos

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

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

  console.log("Added event handlers for when paragraphs are deleted.");
});

...

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