Novidades no Word JavaScript API 1.1

O WordApi 1.1 é o primeiro conjunto de requisitos da Word API JavaScript. É o único conjunto de requisitos da API Word suportado pelo Word 2016.

Lista de API

A tabela seguinte lista as APIs no Word conjunto de requisitos da API JavaScript 1.1. Para ver a documentação de referência da API para todas as APIs suportadas pelo Word conjunto de requisitos da API JavaScript 1.1, veja Word APIs no conjunto de requisitos 1.1.

Classe Campos Descrição
Body clear() Limpa o conteúdo do objeto Body.
contentControls Obtém a coleção de objetos de controlo de conteúdo de texto formatado no corpo.
font Obtém o formato de texto do corpo.
getHtml() Obtém uma representação HTML do objeto do corpo.
getOoxml() Obtém a representação OOXML (Office Open XML) do objeto Body.
inlinePictures Obtém a coleção de objetos InlinePicture no corpo.
insertBreak(breakType: Word. BreakType | "Página" | "Seguinte" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Linha", insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Iniciar" | "Fim") Insere uma quebra no local especificado no documento principal.
insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "Texto Simples" | "Caixa de Verificação" | "DropDownList" | "Caixa de Combinação") Molda o objeto Corpo com um controlo de conteúdo.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere um documento no corpo, no local especificado.
insertHtml(html: cadeia, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere HTML no local especificado.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere um formato OOXML no local especificado.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Iniciar" | "Fim") Insere um parágrafo no local especificado.
insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere texto no corpo, no local especificado.
paragraphs Obtém a coleção de objetos de parágrafo no corpo.
parentContentControl Obtém o controle de conteúdo que inclui o corpo.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Efetua uma pesquisa com as SearchOptions especificadas no âmbito do objeto do corpo.
select(selectionMode?: Word. SelectionMode) Seleciona o corpo e navega na interface do usuário do Word até ele.
style Especifica o nome do estilo do corpo.
text Obtém o texto do corpo.
ContentControl aspeto Especifica o aspeto do controlo de conteúdo.
cannotDelete Especifica um valor que indica se o utilizador pode eliminar o controlo de conteúdo.
cannotEdit Especifica um valor que indica se o utilizador pode editar os conteúdos do controlo de conteúdo.
clear() Limpa o conteúdo do controle de conteúdo.
color Especifica a cor do controlo de conteúdo.
contentControls Obtém a coleção de objetos de controle de conteúdo no controle de conteúdo.
delete(keepContent: booleano) Exclui o controle de conteúdo e o respectivo conteúdo.
font Obtém o formato de texto do controle de conteúdo.
getHtml() Obtém uma representação HTML do objeto de controlo de conteúdo.
getOoxml() Obtém a representação OOXML (Office Open XML) do objeto do controle de conteúdo.
id Obtém um número inteiro que representa o identificador do controle de conteúdo.
inlinePictures Obtém a coleção de objetos InlinePicture no controlo de conteúdo.
insertBreak(breakType: Word. BreakType | "Página" | "Seguinte" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Linha", insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Iniciar" | "Fim" | "Antes" | "Depois") Insere uma quebra no local especificado no documento principal.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere um documento no controlo de conteúdo na localização especificada.
insertHtml(html: cadeia, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere HTML no local especificado dentro do controle de conteúdo.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere OOXML no controlo de conteúdo na localização especificada.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Iniciar" | "Fim" | "Antes" | "Depois") Insere um parágrafo no local especificado.
insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere texto no local especificado dentro do controle de conteúdo.
paragraphs Obtém a coleção de objetos de parágrafo no controlo de conteúdo.
parentContentControl Obtém o controle de conteúdo que inclui o controle de conteúdo.
placeholderText Especifica o texto do marcador de posição do controlo de conteúdo.
removeWhenEdited Especifica um valor que indica se o controlo de conteúdo é removido depois de ser editado.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Efetua uma pesquisa com as SearchOptions especificadas no âmbito do objeto de controlo de conteúdo.
select(selectionMode?: Word. SelectionMode) Seleciona o controle de conteúdo.
style Especifica o nome do estilo para o controlo de conteúdo.
marcar Especifica uma etiqueta para identificar um controlo de conteúdo.
text Obtém o texto do controle de conteúdo.
title Especifica o título de um controlo de conteúdo.
type Obtém o tipo de controle de conteúdo.
ContentControlCollection getById(id: number) Obtém um controle de conteúdo pelo respectivo identificador.
getByTag(tag: string) Obtém os controles de conteúdo com a marca especificada.
getByTitle(title: string) Obtém os controles de conteúdo com o título especificado.
getItem(id: número) Obtém um controlo de conteúdo pelo respetivo ID.
items Obtém os itens filhos carregados nesta coleção.
Document body Obtém o objeto do corpo do main documento.
contentControls Obtém a coleção de objetos de controlo de conteúdo no documento.
getSelection() Obtém a seleção atual do documento.
save(saveBehavior?: Word. SaveBehavior, fileName?: string) Salva o documento.
guardado Indica se as alterações do documento foram salvas.
sections Obtém a coleção de objetos de secção no documento.
Font bold Especifica um valor que indica se o tipo de letra está a negrito.
color Especifica a cor do tipo de letra especificado.
doubleStrikeThrough Especifica um valor que indica se o tipo de letra tem uma rasurado dupla.
highlightColor Especifica a cor de realce.
italic Especifica um valor que indica se o tipo de letra está em itálico.
name Especifica um valor que representa o nome do tipo de letra.
size Especifica um valor que representa o tamanho do tipo de letra em pontos.
strikeThrough Especifica um valor que indica se o tipo de letra tem uma rasurado.
subscript Especifica um valor que indica se o tipo de letra é inferior à linha.
superscript Especifica um valor que indica se o tipo de letra é superior à linha.
underline Especifica um valor que indica o tipo de sublinhado do tipo de letra.
InlinePicture altTextDescription Especifica uma cadeia que representa o texto alternativo associado à imagem inline.
altTextTitle Especifica uma cadeia que contém o título da imagem inline.
getBase64ImageSrc() Obtém a representação de cadeia codificada com Base64 da imagem inline.
height Especifica um número que descreve a altura da imagem inline.
hiperlink Especifica uma hiperligação na imagem.
insertContentControl() Quebra a imagem embutida com um controle de conteúdo de rich text.
lockAspectRatio Especifica um valor que indica se a imagem inline mantém as proporções originais quando a redimensiona.
parentContentControl Obtém o controle de conteúdo que inclui a imagem embutida.
width Especifica um número que descreve a largura da imagem inline.
InlinePictureCollection items Obtém os itens filhos carregados nesta coleção.
Paragraph alinhamento Especifica o alinhamento de um parágrafo.
clear() Limpa o conteúdo do objeto Paragraph.
contentControls Obtém a coleção de objetos de controlo de conteúdo no parágrafo.
delete() Exclui o parágrafo e o respectivo conteúdo do documento.
firstLineIndent Especifica o valor, em pontos, para uma primeira linha ou avanço pendente.
font Obtém o formato de texto do parágrafo.
getHtml() Obtém uma representação HTML do objeto de parágrafo.
getOoxml() Obtém a representação OOXML (Office Open XML) do objeto Paragraph.
inlinePictures Obtém a coleção de objetos InlinePicture no parágrafo.
insertBreak(breakType: Word. BreakType | "Página" | "Seguinte" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Linha", insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "Depois") Insere uma quebra no local especificado no documento principal.
insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "Texto Simples" | "Caixa de Verificação" | "DropDownList" | "Caixa de Combinação") Molda o objeto Parágrafo com um controlo de conteúdo.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere um documento no parágrafo na localização especificada.
insertHtml(html: cadeia, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere HTML no local especificado dentro do parágrafo.
insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere uma imagem no local especificado dentro do parágrafo.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere OOXML no parágrafo na localização especificada.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "Depois") Insere um parágrafo no local especificado.
insertText(text: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "Fim") Insere texto no local especificado dentro do parágrafo.
leftIndent Especifica o valor de avanço esquerdo, em pontos, para o parágrafo.
espaçamento entre linhas Especifica o espaçamento entre linhas, em pontos, para o parágrafo especificado.
lineUnitAfter Especifica a quantidade de espaçamento, nas linhas de grelha, após o parágrafo.
lineUnitBefore Especifica a quantidade de espaçamento, nas linhas de grelha, antes do parágrafo.
nível hierárquico Especifica o nível hierárquico do parágrafo.
parentContentControl Obtém o controle de conteúdo que inclui o parágrafo.
rightIndent Especifica o valor de avanço correto, em pontos, para o parágrafo.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Efetua uma pesquisa com as SearchOptions especificadas no âmbito do objeto de parágrafo.
select(selectionMode?: Word. SelectionMode) Seleciona e navega na interface do usuário do Word até o parágrafo.
spaceAfter Especifica o espaçamento, em pontos, após o parágrafo.
spaceBefore Especifica o espaçamento, em pontos, antes do parágrafo.
style Especifica o nome do estilo do parágrafo.
text Obtém o texto do parágrafo.
ParagraphCollection items Obtém os itens filhos carregados nesta coleção.
Range clear() Limpa o conteúdo do objeto Range.
contentControls Obtém a coleção de objetos de controlo de conteúdo no intervalo.
delete() Exclui o intervalo e o respectivo conteúdo do documento.
font Obtém o formato de texto do intervalo.
getHtml() Obtém uma representação HTML do objeto de intervalo.
getOoxml() Obtém a representação OOXML do objeto Range.
insertBreak(breakType: Word. BreakType | "Página" | "Seguinte" | "SectionNext" | "SectionContinuous" | "SectionEven" | "SectionOdd" | "Linha", insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "Depois") Insere uma quebra no local especificado no documento principal.
insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "Texto Simples" | "Caixa de Verificação" | "DropDownList" | "Caixa de Combinação") Molda o objeto Intervalo com um controlo de conteúdo.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation | "Substituir" | "Iniciar" | "Fim" | "Antes" | "Depois") Insere um documento no local especificado.
insertHtml(html: cadeia, insertLocation: Word. InsertLocation | "Substituir" | "Iniciar" | "Fim" | "Antes" | "Depois") Insere HTML no local especificado.
insertOoxml(ooxml: string, insertLocation: Word. InsertLocation | "Substituir" | "Iniciar" | "Fim" | "Antes" | "Depois") Insere um formato OOXML no local especificado.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "Depois") Insere um parágrafo no local especificado.
insertText(text: string, insertLocation: Word. InsertLocation | "Substituir" | "Iniciar" | "Fim" | "Antes" | "Depois") Insere um texto no local especificado.
paragraphs Obtém a coleção de objetos de parágrafo no intervalo.
parentContentControl Obtém o controlo de conteúdo atualmente suportado que contém o intervalo.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Efetua uma pesquisa com as SearchOptions especificadas no âmbito do objeto de intervalo.
select(selectionMode?: Word. SelectionMode) Seleciona e navega na interface do usuário do Word até o intervalo.
style Especifica o nome do estilo do intervalo.
text Obtém o texto do intervalo.
RangeCollection items Obtém os itens filhos carregados nesta coleção.
SearchOptions ignorePunct Especifica um valor que indica se deve ignorar todos os carateres de pontuação entre palavras.
ignoreSpace Especifica um valor que indica se deve ignorar todo o espaço em branco entre palavras.
matchCase Especifica um valor que indica se deve efetuar uma pesquisa sensível a maiúsculas e minúsculas.
correção de correspondência Especifica um valor que indica se deve corresponder as palavras que começam com a cadeia de pesquisa.
matchSuffix Especifica um valor que indica se deve corresponder as palavras que terminam com a cadeia de pesquisa.
matchWholeWord Especifica um valor que indica se pretende localizar apenas palavras inteiras e não texto que faça parte de uma palavra maior.
matchWildcards Especifica um valor que indica se a pesquisa será efetuada com operadores de pesquisa especiais.
Section body Obtém o objeto do corpo da secção.
getFooter(tipo: Word. HeaderFooterType) Obtém um dos rodapés da seção.
getHeader(tipo: Word. HeaderFooterType) Obtém um dos cabeçalhos da seção.
SectionCollection items Obtém os itens filhos carregados nesta coleção.

Confira também