Novidades em Word API JavaScript 1.5

  • Artigo

O WordApi 1.5 adicionou suporte para notas de rodapé, notas de extremidade, eventos de controle de conteúdo e gerenciamento de estilo.

Lista de API

A tabela a seguir lista as APIs no Word o conjunto de requisitos da API JavaScript 1.5. Para exibir a documentação de referência da API para todas as APIs com suporte Word requisitos da API JavaScript 1.5 ou anterior, consulte Word APIs no conjunto de requisitos 1.5 ou anterior.

Classe Campos Descrição
Aplicativo retrieveStylesFromBase64(base64File: string) Analisar estilos do arquivo Base64 do modelo e retornar o formato JSON de estilos recuperados como uma cadeia de caracteres.
Body Notas Obtém a coleção de notas de extremidade no corpo.
Rodapé Obtém a coleção de notas de rodapé no corpo.
getContentControls(options?: Word. ContentControlOptions) Obtém os controles de conteúdo com suporte no momento no corpo.
ContentControl Notas Obtém a coleção de notas de extremidade no controle de conteúdo.
Rodapé Obtém a coleção de notas de rodapé no controle de conteúdo.
getContentControls(options?: Word. ContentControlOptions) Obtém os controles de conteúdo filho com suporte no momento neste controle de conteúdo.
onDataChanged Ocorre quando os dados dentro do controle de conteúdo são alterados.
onDeleted Ocorre quando o controle de conteúdo é excluído.
onEntered Ocorre quando o controle de conteúdo é inserido.
Onexited Ocorre quando o controle de conteúdo é encerrado, por exemplo, quando o cursor deixa o controle de conteúdo.
onSelectionChanged Ocorre quando a seleção dentro do controle de conteúdo é alterada.
Contentcontroladdedeventargs eventType O tipo de evento.
Ids Obtém as IDs de controle de conteúdo.
source A origem do evento.
ContentControlCollection getByChangeTrackingStates(changeTrackingStates: Word. ChangeTrackingState[]) Obtém os controles de conteúdo que têm o estado de acompanhamento especificado.
ContentControlDataChangedEventArgs eventType O tipo de evento.
Ids Obtém as IDs de controle de conteúdo.
source A origem do evento.
ContentControlDeletedEventArgs eventType O tipo de evento.
Ids Obtém as IDs de controle de conteúdo.
source A origem do evento.
ContentControlEnteredEventArgs eventType O tipo de evento.
Ids Obtém as IDs de controle de conteúdo.
source A origem do evento.
ContentControlExitedEventArgs eventType O tipo de evento.
Ids Obtém as IDs de controle de conteúdo.
source A origem do evento.
ContentControlOptions types Uma matriz de tipos de controle de conteúdo, o item deve ser 'RichText' ou 'PlainText'.
ContentControlSelectionChangedEventArgs eventType O tipo de evento.
Ids Obtém as IDs de controle de conteúdo.
source A origem do evento.
Document addStyle(name: string, type: Word. StyleType) Adiciona um estilo ao documento por nome e tipo.
close(closeBehavior?: Word. CloseBehavior) Fecha o documento atual.
getContentControls(options?: Word. ContentControlOptions) Obtém os controles de conteúdo com suporte no momento no documento.
getEndnoteBody() Obtém as notas de extremidade do documento em um único corpo.
getFootnoteBody() Obtém as notas de rodapé do documento em um único corpo.
getStyles() Obtém um objeto StyleCollection que representa todo o conjunto de estilos do documento.
insertFileFromBase64(base64File: string, insertLocation: Word. InsertLocation.replace | Word. InsertLocation.start | Word. InsertLocation.end | "Substituir" | "Iniciar" | "End", insertFileOptions?: Word. InsertFileOptions) Insere um documento no documento de destino em um local específico com propriedades adicionais.
onContentControlAdded Ocorre quando um controle de conteúdo é adicionado.
save(saveBehavior?: Word. SaveBehavior, fileName?: string) Salva o documento.
Campo code Especifica as instruções de código do campo.
data Especifica dados em um campo "Addin".
delete() Exclui o campo.
kind Obtém o tipo do campo.
bloqueado Especifica se o campo está bloqueado.
select(selectionMode?: Word. SelectionMode) Seleciona o campo.
type Obtém o tipo do campo.
updateResult() Atualizações campo.
FieldCollection getByTypes(tipos: Word. FieldType[]) Obtém a coleção de objetos Field, incluindo os tipos de campos especificados.
InsertFileOptions importChangeTrackingMode Representa se o modo de controle de alterações status do documento de origem deve ser importado.
importPageColor Representa se a cor da página e outras informações em segundo plano do documento de origem devem ser importadas.
importParagraphSpacing Representa se o espaçamento de parágrafo do documento de origem deve ser importado.
importStyles Representa se os estilos do documento de origem devem ser importados.
importTheme Representa se o tema do documento de origem deve ser importado.
Item de nota body Representa o objeto body do item de nota.
delete() Exclui o item de observação.
getNext() Obtém o próximo item de observação do mesmo tipo.
getNextOrNullObject() Obtém o próximo item de observação do mesmo tipo.
reference Representa uma nota de rodapé ou uma referência de nota de extremidade no documento main.
type Representa o tipo de item de observação: nota de rodapé ou nota de extremidade.
NoteItemCollection getFirst() Obtém o primeiro item de nota nesta coleção.
getFirstOrNullObject() Obtém o primeiro item de nota nesta coleção.
items Obtém os itens filhos carregados nesta coleção.
Paragraph Notas Obtém a coleção de notas de extremidade no parágrafo.
Rodapé Obtém a coleção de notas de rodapé no parágrafo.
getContentControls(options?: Word. ContentControlOptions) Obtém os controles de conteúdo com suporte no momento no parágrafo.
ParagraphFormat Alinhamento Especifica o alinhamento dos parágrafos especificados.
firstLineIndent Especifica o valor (em pontos) para um recuo de primeira linha ou de suspensão.
Keeptogether Especifica se todas as linhas nos parágrafos especificados permanecem na mesma página quando a Microsoft Word repagina o documento.
keepWithNext Especifica se o parágrafo especificado permanece na mesma página que o parágrafo que o segue quando a Microsoft Word repagina o documento.
leftIndent Especifica o recuo esquerdo.
lineSpacing Especifica o espaçamento de linha (em pontos) para os parágrafos especificados.
lineUnitAfter Especifica a quantidade de espaçamento (em linhas de grade) após os parágrafos especificados.
lineUnitBefore Especifica a quantidade de espaçamento (em linhas de grade) antes dos parágrafos especificados.
mirrorIndents Especifica se os recuos esquerdo e direito têm a mesma largura.
outlineLevel Especifica o nível de contorno dos parágrafos especificados.
rightIndent Especifica o recuo direito (em pontos) para os parágrafos especificados.
spaceAfter Especifica a quantidade de espaçamento (em pontos) após o parágrafo ou coluna de texto especificado.
spaceBefore Especifica o espaçamento (em pontos) antes dos parágrafos especificados.
widowControl Especifica se as primeiras e últimas linhas no parágrafo especificado permanecem na mesma página que o restante do parágrafo quando a Microsoft Word repagina o documento.
Range Notas Obtém a coleção de notas de extremidade no intervalo.
Rodapé Obtém a coleção de notas de rodapé no intervalo.
getContentControls(options?: Word. ContentControlOptions) Obtém os controles de conteúdo com suporte no momento no intervalo.
insertEndnote(insertText?: string) Insere uma nota de extremidade.
insertField(insertLocation: Word. InsertLocation | "Substituir" | "Iniciar" | "End" | "Antes" | "After", fieldType?: Word. FieldType, text?: string, removeFormatting?: booleano) Insere um campo no local especificado.
insertFootnote(insertText?: string) Insere uma nota de rodapé.
Estilo baseStyle Obtém o nome de um estilo existente a ser usado como a formatação base de outro estilo.
Builtin Obtém se o estilo especificado é um estilo interno.
delete() Exclui o estilo.
font Obtém um objeto de fonte que representa a formatação de caracteres do estilo especificado.
inUse Obtém se o estilo especificado é um estilo interno que foi modificado ou aplicado no documento ou um novo estilo que foi criado no documento.
Ligado Obtém se um estilo é um estilo vinculado que pode ser usado para formatação de parágrafo e caractere.
nameLocal Obtém o nome de um estilo na linguagem do usuário.
nextParagraphStyle Obtém o nome do estilo a ser aplicado automaticamente a um novo parágrafo inserido após um parágrafo formatado com o estilo especificado.
paragraphFormat Obtém um objeto ParagraphFormat que representa as configurações de parágrafo para o estilo especificado.
Prioridade Especifica a prioridade.
quickStyle Especifica se o estilo corresponde a um estilo rápido disponível.
type Obtém o tipo de estilo.
unhideWhenUsed Especifica se o estilo especificado é visível como um estilo recomendado no painel Estilos e no painel de tarefas Estilos na Microsoft Word depois de ser usado no documento.
Visibilidade Especifica se o estilo especificado está visível como um estilo recomendado na galeria Estilos e no painel de tarefas Estilos.
StyleCollection getByName(name: string) Obtenha o objeto style pelo nome.
getByNameOrNullObject(nome: cadeia de caracteres) Se o estilo correspondente não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true.
getCount() Obtém o número dos estilos na coleção.
getItem(index: number) Obtém um objeto de estilo por seu índice na coleção.
items Obtém os itens filhos carregados nesta coleção.
Table Notas Obtém a coleção de notas de extremidade na tabela.
Rodapé Obtém a coleção de notas de rodapé na tabela.
TableRow Notas Obtém a coleção de notas de extremidade na linha da tabela.
Rodapé Obtém a coleção de notas de rodapé na linha de tabela.

Confira também