Partilhar via

Quais são as novidades na API JavaScript do Word 1.3

  • Artigo

O WordApi 1.3 adicionou mais suporte para controlos de conteúdo e definições ao nível do documento.

Lista de API

A tabela seguinte lista as APIs no Word conjunto de requisitos da API JavaScript 1.3. Para ver API reference documentation for all APIs supported by Word JavaScript API requirement set 1.3 or earlier, see Word APIs in requirement set 1.3 or earlier.

Classe Campos Descrição
Aplicativo createDocument(base64File?: cadeia) Cria um novo documento com um ficheiro de .docx codificado em Base64 opcional.
Body getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | "Inteiro" | "Iniciar" | "Fim" | "Depois" | "Conteúdo") Obtém o corpo todo, ou então, os pontos inicial ou final do corpo, como um intervalo.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Iniciar" | "End", values?: string[][]) Insere uma tabela com a quantidade especificada de linhas e colunas.
lists Obtém a coleção de listas de objetos no corpo.
parentBody Obtém o corpo pai do corpo.
parentBodyOrNullObject Obtém o corpo pai do corpo.
parentContentControlOrNullObject Obtém o controle de conteúdo que inclui o corpo.
parentSection Obtém a seção pai do corpo.
parentSectionOrNullObject Obtém a seção pai do corpo.
styleBuiltIn Especifica o nome de estilo incorporado para o corpo.
tabelas Obtém a coleção de tabelas de objetos no corpo.
type Obtém o tipo do corpo.
ContentControl getRange(rangeLocation?: Word. RangeLocation | "Inteiro" | "Iniciar" | "Fim" | "Antes" | "Depois" | "Conteúdo") Obtém o controle de todo o conteúdo, ou então, os pontos inicial ou final do controle de conteúdo, como um intervalo.
getTextRanges(endingMarks: string[], trimSpacing?: booleano) Obtém os intervalos de texto no controlo de conteúdo utilizando marcas de pontuação e/ou outras marcas finais.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Iniciar" | "Fim" | "Antes" | "Depois", valores?: cadeia[][]) Insere uma tabela com a quantidade especificada de linhas e colunas dentro ou próxima do controle de conteúdo.
lists Obtém a coleção de listas de objetos no controle de conteúdo.
parentBody Obtém o corpo pai do controle de conteúdo.
parentContentControlOrNullObject Obtém o controle de conteúdo que inclui o controle de conteúdo.
parentTable Obtém a tabela que contém o controle de conteúdo.
parentTableCell Obtém a célula de tabela que contém o controle de conteúdo.
parentTableCellOrNullObject Obtém a célula de tabela que contém o controle de conteúdo.
parentTableOrNullObject Obtém a tabela que contém o controle de conteúdo.
split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: booleano, trimSpacing?: booleano) Divide o controle de conteúdo em intervalos filho usando delimitadores.
styleBuiltIn Especifica o nome de estilo incorporado para o controlo de conteúdo.
subtipo Obtém o subtipo de controle de conteúdo.
tabelas Obtém a coleção de objetos de tabela no controle de conteúdo.
ContentControlCollection getByIdOrNullObject(id: número) Obtém um controle de conteúdo pelo respectivo identificador.
getByTypes(tipos: Word. ContentControlType[]) Obtém os controlos de conteúdo que têm os tipos especificados.
getFirst() Obtém o primeiro controle de conteúdo nesta coleção.
getFirstOrNullObject() Obtém o primeiro controle de conteúdo nesta coleção.
CustomProperty delete() Exclui a propriedade personalizada.
key Obtém a chave da propriedade personalizada.
type Obtém o tipo de valor da propriedade personalizada.
value Especifica o valor da propriedade personalizada.
CustomPropertyCollection add(key: string, value: any) Cria uma nova propriedade personalizada ou define uma existente.
deleteAll() Exclui todas as propriedades personalizadas nesta coleção.
getCount() Obtém a contagem das propriedades personalizadas.
getItem(key: string) Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas.
getItemOrNullObject(key: string) Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas.
items Obtém os itens filhos carregados nesta coleção.
Document properties Obtém as propriedades do documento.
DocumentCreated abrir() Abre o documento.
DocumentProperties applicationName Obtém o nome do aplicativo do documento.
autor Especifica o autor do documento.
categoria Especifica a categoria do documento.
comments Especifica o campo Comentários nos metadados do documento.
company Especifica a empresa do documento.
creationDate Obtém a data de criação do documento.
customProperties Obtém a coleção de propriedades personalizadas do documento.
format Especifica o formato do documento.
palavras-chave Especifica as palavras-chave do documento.
lastAuthor Obtém o último autor do documento.
lastPrintDate Obtém a data de impressão do documento.
lastSaveTime Obtém a hora em que o documento foi salvo pela última vez.
gestor Especifica o gestor do documento.
revisionNumber Obtém o número de revisão do documento.
segurança Obtém as definições de segurança do documento.
subject Especifica o assunto do documento.
template Obtém o modelo do documento.
title Especifica o título do documento.
InlinePicture getNext() Obtém a próxima imagem embutida.
getNextOrNullObject() Obtém a próxima imagem embutida.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | "Inteiro" | "Iniciar" | "Fim") Obtém a imagem, ou então, os pontos inicial ou final da imagem, como um intervalo.
parentContentControlOrNullObject Obtém o controle de conteúdo que inclui a imagem embutida.
parentTable Obtém a tabela que contém a imagem embutida.
parentTableCell Obtém a célula de tabela que contém a imagem embutida.
parentTableCellOrNullObject Obtém a célula de tabela que contém a imagem embutida.
parentTableOrNullObject Obtém a tabela que contém a imagem embutida.
InlinePictureCollection getFirst() Obtém a primeira imagem embutida nesta coleção.
getFirstOrNullObject() Obtém a primeira imagem embutida nesta coleção.
List getLevelParagraphs(nível: número) Obtém os parágrafos que ocorrem no nível especificado na lista.
getLevelString(nível: número) Obtém a marca, número ou imagem no nível especificado como uma cadeia.
id Obtém o ID da lista.
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.
levelExistences Verifica se cada um dos 9 níveis existe na lista.
levelTypes Obtém todos os tipos de nível 9 na lista.
paragraphs Obtém parágrafos na lista.
setLevelAlignment(nível: número, alinhamento: Word. Alinhamento) Define o alinhamento da marca, número ou imagem no nível especificado na lista.
setLevelBullet(nível: número, listBullet: Word. ListBullet, charCode?: número, fontName?: cadeia) Define o formato de marcador no nível especificado na lista.
setLevelIndents(nível: número, textIndent: número, bulletNumberPictureIndent: número) Define os dois recuos do nível especificado na lista.
setLevelNumbering(nível: número, listNumbering: Word. ListNumbering, formatString?: Cadeia<de matriz | número>) Define o formato de numeração no nível especificado na lista.
setLevelStartingNumber(level: number, startingNumber: number) Define o número inicial no nível especificado na lista.
ListCollection getById(id: number) Obtém uma lista por seu identificador.
getByIdOrNullObject(id: número) Obtém uma lista por seu identificador.
getFirst() Obtém a primeira lista nesta coleção.
getFirstOrNullObject() Obtém a primeira lista nesta coleção.
getItem(id: número) Obtém um objeto de lista pelo respetivo ID.
items Obtém os itens filhos carregados nesta coleção.
ListItem getAncestor(parentOnly?: booleano) Obtém o item principal da lista ou o predecessor mais próximo se o elemento principal não existir.
getAncestorOrNullObject(parentOnly?: booleano) Obtém o item principal da lista ou o predecessor mais próximo se o elemento principal não existir.
getDescendants(directChildrenOnly?: booleano) Obtém todos os itens de lista descendentes do item de lista.
level Especifica o nível do item na lista.
listString Obtém a marca, o número ou a imagem do item de lista como uma cadeia.
siblingIndex Obtém o número da ordem de item de lista em relação a seus irmãos.
Paragraph attachToList(listId: number, level: number) Permite que o parágrafo ingresse em uma lista existente no nível especificado.
detachFromList() Move este parágrafo para fora de sua lista, caso o parágrafo seja um item da lista.
getNext() Obtém o próximo parágrafo.
getNextOrNullObject() Obtém o próximo parágrafo.
getPrevious() Obtém o parágrafo anterior.
getPreviousOrNullObject() Obtém o parágrafo anterior.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | "Inteiro" | "Iniciar" | "Fim" | "Depois" | "Conteúdo") Obtém o parágrafo inteiro, ou então, os pontos inicial ou final do parágrafo, como um intervalo.
getTextRanges(endingMarks: string[], trimSpacing?: booleano) Obtém os intervalos de texto no parágrafo utilizando marcas de pontuação e/ou outras marcas finais.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "Depois", valores?: cadeia[][]) Insere uma tabela com a quantidade especificada de linhas e colunas.
isLastParagraph Indica que o parágrafo é o último dentro do corpo do pai.
isListItem Verifica se o parágrafo é um item da lista.
list Obtém a lista à qual pertence esse parágrafo.
listItem Obtém o ListItem para o parágrafo.
listItemOrNullObject Obtém o ListItem para o parágrafo.
listOrNullObject Obtém a lista à qual pertence esse parágrafo.
parentBody Obtém o corpo pai do parágrafo.
parentContentControlOrNullObject Obtém o controle de conteúdo que inclui o parágrafo.
parentTable Obtém a tabela que contém o parágrafo.
parentTableCell Obtém a célula de tabela que contém o parágrafo.
parentTableCellOrNullObject Obtém a célula de tabela que contém o parágrafo.
parentTableOrNullObject Obtém a tabela que contém o parágrafo.
split(delimiters: string[], trimDelimiters?: booleano, trimSpacing?: booleano) Divide o parágrafo em intervalos filho usando delimitadores.
startNewList() Inicia uma nova lista com este parágrafo.
styleBuiltIn Especifica o nome de estilo incorporado para o parágrafo.
tableNestingLevel Obtém o nível da tabela do parágrafo.
ParagraphCollection getFirst() Obtém o primeiro parágrafo nesta coleção.
getFirstOrNullObject() Obtém o primeiro parágrafo nesta coleção.
getLast() Obtém o último parágrafo nesta coleção.
getLastOrNullObject() Obtém o último parágrafo nesta coleção.
Range compareLocationWith(intervalo: Word. Intervalo) Compara o local deste intervalo com a localização de outro intervalo.
expandTo(intervalo: Word. Intervalo) Retorna um novo intervalo que se estende a partir deste intervalo em qualquer direção para cobrir outro intervalo.
expandToOrNullObject(intervalo: Word. Intervalo) Retorna um novo intervalo que se estende a partir deste intervalo em qualquer direção para cobrir outro intervalo.
getHyperlinkRanges() Obtém intervalos filho de hiperlink dentro do intervalo.
getNextTextRange(endingMarks: string[], trimSpacing?: booleano) Obtém o intervalo de texto seguinte com marcas de pontuação e/ou outras marcas finais.
getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: booleano) Obtém o intervalo de texto seguinte com marcas de pontuação e/ou outras marcas finais.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | "Inteiro" | "Iniciar" | "Fim" | "Depois" | "Conteúdo") Clona o intervalo, ou então, obtém os pontos inicial ou final do intervalo como um novo intervalo.
getTextRanges(endingMarks: string[], trimSpacing?: booleano) Obtém os intervalos subordinados de texto no intervalo com marcas de pontuação e/ou outras marcas finais.
hiperlink Obtém o primeiro hiperlink no intervalo ou define um hiperlink no intervalo.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "Depois", valores?: cadeia[][]) Insere uma tabela com a quantidade especificada de linhas e colunas.
intersectWith(intervalo: Word. Intervalo) Retorna um novo intervalo como ponto de interseção deste intervalo com outro intervalo.
intersectWithOrNullObject(intervalo: Word. Intervalo) Retorna um novo intervalo como ponto de interseção deste intervalo com outro intervalo.
isEmpty Verifica se o comprimento do intervalo é zero.
lists Obtém a coleção de listas de objetos no intervalo.
parentBody Obtém o corpo pai do intervalo.
parentContentControlOrNullObject Obtém o controlo de conteúdo atualmente suportado que contém o intervalo.
parentTable Obtém a tabela que contém o intervalo.
parentTableCell Obtém a célula de tabela que contém o intervalo.
parentTableCellOrNullObject Obtém a célula de tabela que contém o intervalo.
parentTableOrNullObject Obtém a tabela que contém o intervalo.
split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: booleano, trimSpacing?: booleano) Divide o intervalo em intervalos filho usando delimitadores.
styleBuiltIn Especifica o nome de estilo incorporado para o intervalo.
tabelas Obtém a coleção de tabelas de objetos no intervalo.
RangeCollection getFirst() Obtém o primeiro intervalo nesta coleção.
getFirstOrNullObject() Obtém o primeiro intervalo nesta coleção.
RequestContext application [Conjunto de API: WordApi 1.3] *
Section getNext() Obtém a próxima seção.
getNextOrNullObject() Obtém a próxima seção.
SectionCollection getFirst() Obtém a primeira seção nesta coleção.
getFirstOrNullObject() Obtém a primeira seção nesta coleção.
Estilo
Table addColumns(insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Iniciar" | "End", columnCount: number, values?: string[][]) Adiciona colunas ao início ou no final da tabela, usando a primeira ou última coluna existente como um modelo.
addRows(insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Iniciar" | "End", rowCount: number, values?: string[][]) Adiciona linhas ao início ou no final da tabela, usando a primeira ou última linha existente como um modelo.
alinhamento Especifica o alinhamento da tabela em relação à coluna de página.
ajuste automáticoWindow() Autoajusta as colunas da tabela para a largura da janela.
clear() Limpa o conteúdo da tabela.
delete() Exclui toda a tabela.
deleteColumns(columnIndex: number, columnCount?: number) Exclui colunas específicas.
deleteRows(rowIndex: number, rowCount?: number) Exclui linha específicas.
distributeColumns() Distribui uniformemente a largura das colunas.
font Obtém a fonte.
getBorder(borderLocation: Word. BorderLocation) Obtém o estilo de borda para a borda especificada.
getCell(rowIndex: number, cellIndex: number) Obtém a célula da tabela em uma linha e coluna especificada.
getCellOrNullObject(rowIndex: number, cellIndex: number) Obtém a célula da tabela em uma linha e coluna especificada.
getCellPadding(cellPaddingLocation: Word. CellPaddingLocation) Obtém o preenchimento de célula em pontos.
getNext() Obtém a próxima tabela.
getNextOrNullObject() Obtém a próxima tabela.
getParagraphAfter() Obtém o parágrafo após a tabela.
getParagraphAfterOrNullObject() Obtém o parágrafo após a tabela.
getParagraphBefore() Obtém o parágrafo antes da tabela.
getParagraphBeforeOrNullObject() Obtém o parágrafo antes da tabela.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | "Inteiro" | "Iniciar" | "Fim" | "Depois") Obtém o intervalo que contém esta tabela, ou o intervalo no início ou no final da tabela.
headerRowCount Especifica o número de linhas de cabeçalho.
horizontalAlignment Especifica o alinhamento horizontal de cada célula na tabela.
insertContentControl() Insere um controle de conteúdo na tabela.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "Depois") Insere um parágrafo no local especificado.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "Depois", valores?: cadeia[][]) Insere uma tabela com a quantidade especificada de linhas e colunas.
isUniform Indica se todas as linhas de tabela são uniformes.
aninhamentoLevel Obtém o nível de aninhamento da tabela.
parentBody Obtém o corpo pai da tabela.
parentContentControl Obtém o controle de conteúdo que contém a tabela.
parentContentControlOrNullObject Obtém o controle de conteúdo que contém a tabela.
parentTable Obtém a tabela que contém esta tabela.
parentTableCell Obtém a célula de tabela que contém esta tabela.
parentTableCellOrNullObject Obtém a célula de tabela que contém esta tabela.
parentTableOrNullObject Obtém a tabela que contém esta tabela.
rowCount Obtém a quantidade de linhas na tabela.
rows Obtém todas as linhas da tabela.
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 tabela.
select(selectionMode?: Word. SelectionMode) Seleciona a tabela, ou então, a posição no início ou no final da tabela e navega na interface do usuário do Word até ela.
setCellPadding(cellPaddingLocation: Word. CellPaddingLocation, cellPadding: number) Define o preenchimento de célula em pontos.
shadingColor Especifica a cor do sombreado.
style Especifica o nome do estilo da tabela.
styleBandedColumns Especifica se a tabela tem colunas listadas.
styleBandedRows Especifica se a tabela tem linhas listadas.
styleBuiltIn Especifica o nome de estilo incorporado para a tabela.
styleFirstColumn Especifica se a tabela tem uma primeira coluna com um estilo especial.
styleLastColumn Especifica se a tabela tem uma última coluna com um estilo especial.
styleTotalRow Especifica se a tabela tem uma linha total (última) com um estilo especial.
tabelas Obtém as tabelas filho aninhadas em um nível mais profundo.
values Especifica os valores de texto na tabela, como uma matriz JavaScript 2D.
verticalAlignment Especifica o alinhamento vertical de cada célula na tabela.
width Especifica a largura da tabela em pontos.
TableBorder color Especifica a cor do limite da tabela.
type Especifica o tipo do limite da tabela.
width Especifica a largura, em pontos, do limite da tabela.
TableCell body Obtém o objeto do corpo da célula.
cellIndex Obtém o índice da célula em sua linha.
columnWidth Especifica a largura da coluna da célula em pontos.
deleteColumn() Exclui a coluna que contém essa célula.
deleteRow() Exclui a linha que contém essa célula.
getBorder(borderLocation: Word. BorderLocation) Obtém o estilo de borda para a borda especificada.
getCellPadding(cellPaddingLocation: Word. CellPaddingLocation) Obtém o preenchimento de célula em pontos.
getNext() Obtém a próxima célula.
getNextOrNullObject() Obtém a próxima célula.
horizontalAlignment Especifica o alinhamento horizontal da célula.
insertColumns(insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "After", columnCount: number, values?: string[][]) Adiciona colunas à esquerda ou à direita da célula, usando a coluna da célula como um modelo.
insertRows(insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "After", rowCount: number, values?: string[][]) Insere linhas acima ou abaixo da célula, usando a linha da célula como um modelo.
parentRow Obtém a linha pai da célula.
parentTable Obtém a tabela pai da célula.
rowIndex Obtém o índice da linha da célula na tabela.
setCellPadding(cellPaddingLocation: Word. CellPaddingLocation, cellPadding: number) Define o preenchimento de célula em pontos.
shadingColor Especifica a cor de sombreado da célula.
value Especifica o texto da célula.
verticalAlignment Especifica o alinhamento vertical da célula.
width Obtém a largura da célula em pontos.
TableCellCollection getFirst() Obtém a primeira célula da tabela nesta coleção.
getFirstOrNullObject() Obtém a primeira célula da tabela nesta coleção.
items Obtém os itens filhos carregados nesta coleção.
TableCollection getFirst() Obtém a primeira tabela nesta coleção.
getFirstOrNullObject() Obtém a primeira tabela nesta coleção.
items Obtém os itens filhos carregados nesta coleção.
TableRow cellCount Obtém a quantidade de células na linha.
células Obtém células.
clear() Limpa o conteúdo da linha.
delete() Exclui toda a linha.
font Obtém a fonte.
getBorder(borderLocation: Word. BorderLocation) Obtém o estilo de borda das células na linha.
getCellPadding(cellPaddingLocation: Word. CellPaddingLocation) Obtém o preenchimento de célula em pontos.
getNext() Obtém a próxima linha.
getNextOrNullObject() Obtém a próxima linha.
horizontalAlignment Especifica o alinhamento horizontal de cada célula na linha.
insertRows(insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Antes" | "After", rowCount: number, values?: string[][]) Insere linhas usando esta linha como um modelo.
isHeader Verifica se a linha é uma linha de cabeçalho.
parentTable Obtém uma tabela pai.
preferredHeight Especifica a altura preferencial da linha em pontos.
rowIndex Obtém o índice da linha em sua tabela pai.
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 da linha.
select(selectionMode?: Word. SelectionMode) Seleciona a linha e navega na interface do usuário do Word até ele.
setCellPadding(cellPaddingLocation: Word. CellPaddingLocation, cellPadding: number) Define o preenchimento de célula em pontos.
shadingColor Especifica a cor do sombreado.
values Especifica os valores de texto na linha, como uma matriz JavaScript 2D.
verticalAlignment Especifica o alinhamento vertical das células na linha.
TableRowCollection getFirst() Obtém a primeira linha nesta coleção.
getFirstOrNullObject() Obtém a primeira linha nesta coleção.
items Obtém os itens filhos carregados nesta coleção.

Confira também