API JavaScript do Word conjunto de requisitos somente para área de trabalho 1.1

O WordApiDesktop conjunto de requisitos é um conjunto de requisitos especiais que inclui recursos disponíveis apenas para o Word no Windows, no Mac e no iPad. As APIs nesse conjunto de requisitos são consideradas APIs de produção para o aplicativo Word no Windows, no Mac e no iPad. Elas seguem as políticas de suporte para desenvolvedores do Microsoft 365. WordApiDesktop As APIs são consideradas APIs de "visualização" para outras plataformas (Web) e podem não ter suporte em nenhuma dessas plataformas.

Quando as WordApiDesktop APIs no conjunto de requisitos tiverem suporte em todas as plataformas, elas serão adicionadas ao próximo conjunto de requisitos lançado (WordApi 1.[NEXT]). Depois que o novo conjunto de requisitos for público, essas APIs também continuarão a ser marcadas nesse WordApiDesktop conjunto de requisitos. Para saber mais sobre requisitos específicos da plataforma em geral, consulte Noções básicas sobre conjuntos de requisitos específicos da plataforma.

Importante

WordApiDesktop 1.1 é um conjunto de requisitos somente para desktop. É um superconjunto do WordApi 1.8.

Como as WordApiDesktop 1.1 APIs só têm suporte no Word no Windows, no Mac e no iPad, seu suplemento deve marcar se o conjunto de requisitos tem suporte antes de chamar essas APIs. Isso evita qualquer tentativa de usar APIs somente de desktop em uma plataforma sem suporte.

if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.1")) {
   // Any API exclusive to this WordApiDesktop requirement set.
}

Depois que a API estiver em um conjunto de requisitos de plataforma cruzada, você deverá remover ou editar a isSetSupported marcação. Isso habilitará o recurso do seu suplemento em outras plataformas. Certifique-se de testar o recurso nessas plataformas ao fazer essa alteração.

Importante

Seu manifesto não pode ser especificado WordApiDesktop 1.1 como um requisito de ativação. Não é um valor válido a ser usado no elemento Set.

Lista de APIs

A tabela a seguir lista as APIs JavaScript do Word atualmente incluídas no WordApiDesktop 1.1 conjunto de requisitos. Para obter uma lista completa de todas as APIs JavaScript do Word (incluindo WordApiDesktop 1.1 APIs e APIs lançadas anteriormente), consulte todas as APIs JavaScript do Word.

Classe Campos Descrição
Border color Especifica a cor da borda.
location Obtém a localização da borda.
type Especifica o tipo de borda para a borda.
visible Especifica se a borda é visível.
width Especifica a largura da borda.
BorderCollection getByLocation(borderLocation: Word.BorderLocation.top | Word. BorderLocation.left | Word. BorderLocation.bottom | Word. BorderLocation.right | Word. BorderLocation.insideHorizontal | Word. BorderLocation.insideVertical | "Topo" | "Esquerda" | "Fundo" | "Certo" | "DentroHorizontal" | "InsideVertical") Obtém a borda que tem o local especificado.
getFirst() Obtém a primeira borda nesta coleção.
getFirstOrNullObject() Obtém a primeira borda nesta coleção.
getItem(index: number) Obtém um Border objeto por seu índice na coleção.
insideBorderColor Especifica a cor de 24 bits das bordas internas.
insideBorderType Especifica o tipo de borda das bordas internas.
insideBorderWidth Especifica a largura das bordas internas.
items Obtém os itens filhos carregados nesta coleção.
outsideBorderColor Especifica a cor de 24 bits das bordas externas.
outsideBorderType Especifica o tipo de borda das bordas externas.
outsideBorderWidth Especifica a largura das bordas externas.
Document compare(filePath: string, documentCompareOptions?: Word. DocumentCompareOptions) Exibe marcas de revisão que indicam onde o documento especificado difere de um outro documento.
importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word. ImportedStylesConflictBehavior) Importe estilos de uma cadeia de caracteres formatada em JSON.
DocumentCompareOptions addToRecentFiles Se fornecido, especifica se o documento deve ser adicionado à lista de arquivos usados recentemente no menu Arquivo .
authorName Se fornecido, especifica o nome do revisor associado às diferenças geradas pela comparação.
compareTarget Se fornecido, especifica o documento de destino para a comparação.
detectFormatChanges Se fornecido, especifica se a comparação deve incluir a detecção de alterações de formato.
ignoreAllComparisonWarnings Se fornecido, especifica se os documentos devem ser comparados sem notificar um usuário sobre problemas.
removeDateAndTime Se fornecido, especifica se as informações de carimbo de data e hora devem ser removidas das alterações controladas no objeto retornado Document .
removePersonalInformation Se fornecido, especifica se todas as informações do usuário devem ser removidas dos comentários, revisões e da caixa de diálogo de propriedades no objeto retornado Document .
Field showCodes Especifica se os códigos de campo são exibidos para o campo especificado.
InlinePicture formato de imagem Obtém o formato da imagem embutida.
List getLevelFont(level: number) Obtém a fonte do marcador, número ou imagem no nível especificado na lista.
getLevelPicture(level: number) Obtém a representação da cadeia de caracteres codificada em Base64 da imagem no nível especificado na lista.
resetLevelFont(level: number, resetFontName?: boolean) Redefine a fonte do marcador, número ou imagem no nível especificado na lista.
setLevelPicture(level: number, base64EncodedImage?: string) Define a imagem no nível especificado na lista.
ListLevel alinhamento Especifica o alinhamento horizontal do nível de lista.
font Obtém um Font objeto que representa a formatação de caracteres do ListLevel objeto.
linkedStyle Especifica o nome do estilo vinculado ao ListLevel objeto.
numberFormat Especifica o formato de número para o nível de lista.
numberPosition Especifica a posição (em pontos) do número ou marcador do ListLevel objeto.
numberStyle Especifica o estilo de número do ListLevel objeto.
resetOnHigher Especifica o nível de lista que deve ser exibido antes de reiniciar a numeração em 1.
startAt Especifica o número inicial do ListLevel objeto.
tabPosition Especifica a posição da tabulação para o ListLevel objeto.
textPosition Especifica a posição (em pontos) da segunda linha de quebra de texto ListLevel do objeto.
trailingCharacter Especifica o caractere inserido após o número para o nível de lista.
ListLevelCollection getFirst() Obtém o primeiro nível de lista nesta coleção.
getFirstOrNullObject() Obtém o primeiro nível de lista nesta coleção.
items Obtém os itens filhos carregados nesta coleção.
ListTemplate listLevels Obtém um ListLevelCollection objeto que representa todos os níveis do modelo de lista.
outlineNumbered Especifica se o modelo de lista é numerado em estrutura de tópicos.
Shading foregroundPatternColor Especifica a cor do primeiro plano do objeto.
textura Especifica a textura de sombreamento do objeto.
Estilo Borders Especifica um BorderCollection objeto que representa todas as bordas do estilo.
listTemplate Obtém um ListTemplate objeto que representa a formatação da lista para o estilo.
TableRow insertContentControl() Insere um controle de conteúdo na linha.
TableStyle alinhamento Especifica o alinhamento da tabela em relação à margem da página.
allowBreakAcrossPage Especifica se as linhas em tabelas formatadas com um estilo quebram as páginas.

Confira também

  • Last updated on