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

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.2 é um conjunto de requisitos somente para desktop. É um superconjunto de WordApi 1.9 e WordApiDesktop 1.1.

Como as WordApiDesktop 1.2 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.2")) {
   // 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.2 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.2 conjunto de requisitos. Para obter uma lista completa de todas as APIs JavaScript do Word (incluindo WordApiDesktop 1.2 APIs e APIs lançadas anteriormente), consulte todas as APIs JavaScript do Word.

Classe Campos Descrição
Body shapes Obtém a coleção de Shape objetos no corpo, incluindo formas embutidas e flutuantes.
Canvas id Obtém um número inteiro que representa o identificador de tela.
shape Obtém o Shape objeto associado à tela.
shapes Obtém a coleção do Word. Formar objetos.
Document activeWindow Obtém a janela ativa para o documento.
compareFromBase64(base64File: string, documentCompareOptions?: Word. DocumentCompareOptions) Exibe marcas de revisão que indicam onde o documento especificado difere de um outro documento.
janelas Obtém a coleção de Word.Window objetos para o documento.
Font hidden Especifica se a fonte está marcada como oculta.
InsertShapeOptions height Se fornecido, especifica a altura da forma que está sendo inserida.
left Se fornecido, especifica a posição esquerda da forma que está sendo inserida.
top Se fornecido, especifica a posição superior da forma que está sendo inserida.
width Se fornecido, especifica a largura da forma que está sendo inserida.
Page getNext() Obtém a próxima página no painel.
getNextOrNullObject() Obtém a próxima página.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | "Todo" | "Começar" | "Fim") Obtém a página inteira ou o ponto inicial ou final da página como um intervalo.
height Obtém a altura, em pontos, do papel definido na caixa de diálogo Configuração de página.
índice Obtém o índice da página.
width Obtém a largura, em pontos, do papel definido na caixa de diálogo Configuração de página.
PageCollection getFirst() Obtém a primeira página nesta coleção.
getFirstOrNullObject() Obtém a primeira página nesta coleção.
items Obtém os itens filhos carregados nesta coleção.
Painel getNext() Obtém o próximo painel na janela.
getNextOrNullObject() Obtém o próximo painel.
pages Obtém a coleção de páginas no painel.
pagesEnclosingViewport Obtém o PageCollection mostrado no visor do painel.
PaneCollection getFirst() Obtém o primeiro painel nesta coleção.
getFirstOrNullObject() Obtém o primeiro painel nesta coleção.
items Obtém os itens filhos carregados nesta coleção.
Paragraph insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Insere uma tela flutuante na frente do texto com sua âncora no início do parágrafo.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Insere uma forma geométrica na frente do texto com sua âncora no início do parágrafo.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Insere uma imagem flutuante na frente do texto com sua âncora no início do parágrafo.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Insere uma caixa de texto flutuante na frente do texto com sua âncora no início do parágrafo.
shapes Obtém a coleção de Shape objetos ancorados no parágrafo, incluindo formas embutidas e flutuantes.
Range insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Insere uma tela flutuante na frente do texto com sua âncora no início do intervalo.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Insere uma forma geométrica na frente do texto com sua âncora no início do intervalo.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Insere uma imagem flutuante na frente do texto com sua âncora no início do intervalo.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Insere uma caixa de texto flutuante na frente do texto com sua âncora no início do intervalo.
pages Obtém a coleção de páginas no intervalo.
shapes Obtém a coleção de Shape objetos ancorados no intervalo, incluindo formas embutidas e flutuantes.
Formato allowOverlap Especifica se uma determinada forma pode se sobrepor a outras formas.
altTextDescription Especifica uma cadeia de caracteres que representa o texto alternativo associado à forma.
body Obtém o Body objeto da forma.
de tela Obtém a tela associada à forma.
delete() Exclui a forma e seu conteúdo.
fill Retorna a formatação de preenchimento da forma.
geometricShapeType Especifica o tipo de forma geométrica da forma.
height Especifica a altura, em pontos, da forma.
heightRelative Especifica a porcentagem da altura da forma para o tamanho vertical relativo (ou seja, a relativeVerticalSize propriedade).
id Obtém um número inteiro que representa o identificador de forma.
isChild Verifique se essa forma é filho de uma forma de grupo ou de uma forma de tela.
left Especifica a distância, em pontos, do lado esquerdo da forma até a posição horizontal relativa (ou seja, a relativeHorizontalPosition propriedade).
leftRelative Especifica a posição relativa à esquerda como uma porcentagem do lado esquerdo da forma até a posição horizontal relativa (ou seja, a relativeHorizontalalPosition propriedade).
lockAspectRatio Especifica se a taxa de proporção dessa forma está bloqueada.
moveHorizontally(distance: number) Move a forma horizontalmente pelo número de pontos.
moveVertically(distance: number) Move a forma verticalmente pelo número de pontos.
name Especifica o nome da forma.
parentCanvas Obtém a forma de tela pai de nível superior dessa forma filho.
parentGroup Obtém a forma de grupo pai de nível superior dessa forma filho.
relativeHorizontalPosition Especifica a posição horizontal relativa da forma.
relativeHorizontalSize Especifica o tamanho horizontal relativo da forma.
relativeVerticalPosition Especifica a posição vertical relativa da forma.
relativeVerticalSize Especifica o tamanho vertical relativo da forma.
rotation Especifica a rotação, em graus, da forma.
scaleHeight(scaleFactor: number, scaleType: Word. ShapeScaleType, scaleFrom?: Word. ShapeScaleFrom) Dimensiona a altura da forma por um fator especificado.
scaleWidth(scaleFactor: number, scaleType: Word. ShapeScaleType, scaleFrom?: Word. ShapeScaleFrom) Dimensiona a largura da forma por um fator especificado.
select(selectMultipleShapes?: boolean) Seleciona a forma.
shapeGroup Obtém o grupo de formas associado à forma.
textFrame Obtém o TextFrame objeto da forma.
quebra de texto Retorna a formatação de quebra automática de texto da forma.
top Especifica a distância, em pontos, da borda superior da forma até a posição vertical relativa (ou seja, a relativeVerticalPosition propriedade).
topRelative Especifica a posição superior relativa como uma porcentagem da borda superior da forma até a posição vertical relativa (ou seja, a relativeVerticalPosition propriedade).
type Obtém o tipo de forma.
visible Especifica se a forma é visível.
width Especifica a largura, em pontos, da forma.
widthRelative Especifica a porcentagem da largura da forma em relação ao tamanho horizontal relativo (ou seja, a relativeHorizontalSize propriedade).
ShapeCollection getByGeometricTypes(types: Word. GeometricShapeType[]) Obtém as formas que têm os tipos geométricos especificados.
getById(id: number) Recebe uma forma por seu identificador.
getByIdOrNullObject(id: number) Recebe uma forma por seu identificador.
getByIds(ids: number[]) Obtém as formas pelos identificadores.
getByNames(names: string[]) Obtém as formas que têm os nomes especificados.
getByTypes(types: Word. ShapeType[]) Obtém as formas que têm os tipos especificados.
getFirst() Obtém a primeira forma nesta coleção.
getFirstOrNullObject() Obtém a primeira forma nesta coleção.
group() Agrupa formas flutuantes nesta coleção, as formas embutidas serão ignoradas.
items Obtém os itens filhos carregados nesta coleção.
ShapeFill backgroundColor Especifica a cor do plano de fundo de preenchimento de forma.
clear() Limpa a formatação de preenchimento desta forma e a define como Word.ShapeFillType.noFill.
foregroundColor Especifica a cor do primeiro plano do preenchimento da forma.
setSolidColor(color: string) Define a formatação de preenchimento de um formato com uma cor uniforme.
transparency Especifica a porcentagem de transparência do preenchimento como um valor de 0,0 (opaco) a 1,0 (claro).
tipo Retorna o tipo de preenchimento da forma.
ShapeGroup id Obtém um número inteiro que representa o identificador do grupo de formas.
shape Obtém o Shape objeto associado ao grupo.
shapes Obtém a coleção de Shape objetos.
ungroup() Desagrupa todas as formas agrupadas no grupo de forma especificado.
ShapeTextWrap bottomDistance Especifica a distância (em pontos) entre o texto do documento e a borda inferior da área livre de texto ao redor da forma especificada.
leftDistance Especifica a distância (em pontos) entre o texto do documento e a borda esquerda da área livre de texto ao redor da forma especificada.
rightDistance Especifica a distância (em pontos) entre o texto do documento e a borda direita da área livre de texto ao redor da forma especificada.
lateral Especifica se o texto do documento deve ser quebrado em ambos os lados da forma especificada, somente no lado esquerdo ou direito, ou no lado da forma mais distante da margem da página.
topDistance Especifica a distância (em pontos) entre o texto do documento e a borda superior da área livre de texto ao redor da forma especificada.
type Especifica o tipo de quebra automática de texto em torno da forma.
TextFrame autoSizeSetting Especifica as configurações de dimensionamento automático para o quadro de texto.
bottomMargin Especifica a margem inferior, em pontos, do quadro de texto.
hasText Retorna true se o quadro de texto contiver texto, caso contrário, false.
leftMargin Especifica a margem esquerda, em pontos, do quadro de texto.
noTextRotation Especifica se o texto no quadro de texto não deve girar quando a forma é girada.
orientation Especifica o ângulo no qual o texto é orientado para o quadro de texto.
rightMargin Especifica a margem direita, em pontos, do quadro de texto.
topMargin Especifica a margem superior, em pontos, do quadro de texto.
verticalAlignment Especifica o alinhamento vertical do quadro de texto.
quebra automática de texto Determina se as linhas são quebradas automaticamente para caber o texto dentro da forma.
Janela Painel Ativo Obtém o painel ativo na janela.
painéis Obtém a coleção de painéis na janela.
WindowCollection getFirst() Obtém a primeira janela nesta coleção.
getFirstOrNullObject() Obtém a primeira janela nesta coleção.
items Obtém os itens filhos carregados nesta coleção.

Confira também

  • Last updated on