Compartilhar via

Word o conjunto de requisitos apenas para ambiente de trabalho da API JavaScript 1.2

  • Artigo

O WordApiDesktop conjunto de requisitos é um conjunto de requisitos especial que inclui funcionalidades que só estão disponíveis para Word no Windows, no Mac e no iPad. As APIs neste conjunto de requisitos são consideradas APIs de produção para a aplicação Word no Windows, no Mac e no iPad. Seguem as políticas de suporte para programadores do Microsoft 365. WordApiDesktop As APIs são consideradas APIs de "pré-visualização" para outras plataformas (Web) e podem não ser suportadas por nenhuma dessas plataformas.

Quando as APIs no WordApiDesktop conjunto de requisitos são suportadas em todas as plataformas, serão adicionadas ao próximo conjunto de requisitos de lançamento (WordApi 1.[NEXT]). Assim que o novo conjunto de requisitos for público, essas APIs também continuarão a ser etiquetadas neste WordApiDesktop conjunto de requisitos. Para saber mais sobre os requisitos específicos da plataforma em geral, veja Compreender os conjuntos de requisitos específicos da plataforma.

Importante

WordApiDesktop 1.2 é um conjunto de requisitos apenas para ambiente de trabalho. É um superconjunto do WordApi 1.9 e WordApiDesktop 1.1.

Uma vez que as APIs só são suportadas por Word no Windows, no Mac e no iPad, o WordApiDesktop 1.2 suplemento deve marcar se o conjunto de requisitos for suportado antes de chamar estas APIs. Isto evita qualquer tentativa de utilização de APIs apenas de ambiente de trabalho numa plataforma não suportada.

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

Assim que a API estiver num conjunto de requisitos para várias plataformas, deve remover ou editar o isSetSupported marcar. Isto irá ativar a funcionalidade do seu suplemento noutras plataformas. Certifique-se de que testa a funcionalidade nessas plataformas ao efetuar esta alteração.

Importante

O manifesto não pode especificar WordApiDesktop 1.2 como um requisito de ativação. Não é um valor válido a utilizar no elemento Set.

Lista de API

A tabela seguinte lista as APIs javaScript Word atualmente incluídas no WordApiDesktop 1.2 conjunto de requisitos. Para obter uma lista completa de todas as APIs JavaScript Word (incluindo WordApiDesktop 1.2 APIs e APIs lançadas anteriormente), veja todas as APIs javaScript Word.

Classe Campos Descrição
Body shapes Obtém a coleção de objetos de forma no corpo, incluindo formas inline e flutuantes.
Canvas id Obtém um número inteiro que representa o identificador de tela.
shape Obtém o objeto Forma associado à tela.
shapes Obtém a coleção de objetos De forma.
Document activeWindow Obtém a janela ativa do documento.
compareFromBase64(base64File: cadeia, documentCompareOptions?: Word. DocumentCompareOptions) Exibe marcas de revisão que indicam onde o documento especificado difere de um outro documento.
windows Obtém a coleção de Word.Window objetos do documento.
InsertShapeOptions height Representa a altura da forma que está a ser inserida.
left Representa a posição esquerda da forma que está a ser inserida.
top Representa a posição superior da forma que está a ser inserida.
width Representa a largura da forma que está a ser inserida.
Page getNext() Obtém a página seguinte no painel.
getNextOrNullObject() Obtém a página seguinte.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | "Inteiro" | "Iniciar" | "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 Configurar 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 Configurar 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 painel seguinte na janela.
getNextOrNullObject() Obtém o painel seguinte.
pages Obtém a coleção de páginas no painel.
pagesEnclosingViewport Obtém o PageCollection mostrado na janela viewport 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 à frente do texto com a respetiva âncora no início do parágrafo.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Insere uma forma geométrica à frente do texto com a respetiva âncora no início do parágrafo.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Insere uma imagem flutuante à frente do texto com a respetiva âncora no início do parágrafo.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Insere uma caixa de texto flutuante à frente do texto com a respetiva âncora no início do parágrafo.
shapes Obtém a coleção de objetos de forma ancoradas no parágrafo, incluindo formas inline e flutuantes.
Range insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Insere uma tela flutuante à frente do texto com a respetiva âncora no início do intervalo.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Insere uma forma geométrica à frente do texto com a respetiva âncora no início do intervalo.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Insere uma imagem flutuante à frente do texto com a respetiva âncora no início do intervalo.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Insere uma caixa de texto flutuante à frente do texto com a respetiva âncora no início do intervalo.
pages Obtém a coleção de páginas no intervalo.
shapes Obtém a coleção de objetos de forma ancoradas no intervalo, incluindo formas inline e flutuantes.
Formato allowOverlap Especifica se uma determinada forma pode sobrepor-se a outras formas.
altTextDescription Especifica uma cadeia que representa o texto alternativo associado à forma.
body Representa o objeto do corpo da forma.
tela Obtém a tela associada à forma.
delete() Elimina a forma e o respetivo conteúdo.
fill Devolve a formatação de preenchimento da forma.
geometricShapeType O tipo de forma geométrica da forma.
height A altura, em pontos, da forma.
heightRelative A percentagem da altura da forma para o tamanho relativo vertical, veja Word. RelativeSize.
id Obtém um número inteiro que representa o identificador da forma.
isChild Verifique se esta forma é subordinada de uma forma de grupo ou de uma forma de tela.
left A distância, em pontos, desde o lado esquerdo da forma até à posição relativa horizontal, veja Word. RelativeHorizontalPosition.
leftRelative A posição relativa esquerda como uma percentagem do lado esquerdo da forma para a posição relativa horizontal, veja Word. RelativeHorizontalPosition.
lockAspectRatio Especifica se a proporção desta forma está bloqueada.
moveHorizontally(distância: número) Move a forma horizontalmente pelo número de pontos.
moveVerticamente(distância: número) Move a forma verticalmente pelo número de pontos.
name O nome da forma.
parentCanvas Obtém a forma de tela principal de nível superior desta forma subordinada.
parentGroup Obtém a forma de grupo principal de nível superior desta forma subordinada.
relativeHorizontalPosition A posição horizontal relativa da forma.
relativeHorizontalSize O tamanho horizontal relativo da forma.
relativeVerticalPosition A posição vertical relativa da forma.
relativeVerticalSize 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?: booleano) Seleciona a forma.
shapeGroup Obtém o grupo de formas associado à forma.
textFrame Obtém o objeto de moldura de texto da forma.
textWrap Devolve a formatação de moldagem do texto da forma.
top A distância, em pontos, desde a margem superior da forma até à posição relativa vertical, veja Word. RelativeVerticalPosition.
topRelative A posição superior relativa como uma percentagem da margem superior da forma para a posição relativa vertical, veja Word. RelativeVerticalPosition.
type Obtém o tipo de forma.
visible Especifica se a forma está visível.
width A largura, em pontos, da forma.
widthRelative A percentagem de largura da forma para o tamanho relativo horizontal, veja Word. RelativeSize.
ShapeCollection getByGeometricTypes(tipos: Word. GeometricShapeType[]) Obtém as formas que têm os tipos geométricos especificados.
getById(id: number) Obtém uma forma pelo respetivo identificador.
getByIdOrNullObject(id: número) Obtém uma forma pelo respetivo identificador.
getByIds(ids: number[]) Obtém as formas pelos identificadores.
getByNames(names: string[]) Obtém as formas que têm os nomes especificados.
getByTypes(tipos: 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 inline serão ignoradas.
items Obtém os itens filhos carregados nesta coleção.
ShapeFill backgroundColor Especifica a cor de fundo do preenchimento da forma.
clear() Limpa a formatação de preenchimento desta forma e define-a como Word.ShapeFillType.NoFill;
foregroundColor Especifica a cor de 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 percentagem 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 objeto Forma associado ao grupo.
shapes Obtém a coleção de objetos De forma.
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 margem inferior da área sem texto que rodeia a forma especificada.
leftDistance Especifica a distância (em pontos) entre o texto do documento e o limite esquerdo da área sem texto que rodeia a forma especificada.
rightDistance Especifica a distância (em pontos) entre o texto do documento e a margem direita da área sem texto que rodeia a forma especificada.
lado Especifica se o texto do documento deve ser moldado em ambos os lados da forma especificada, apenas no lado esquerdo ou direito ou no lado lateral da forma mais distante da margem da página.
topDistance Especifica a distância (em pontos) entre o texto do documento e a margem superior da área sem texto que rodeia a forma especificada.
type Especifica o tipo de moldagem do texto à volta da forma.
TextFrame autoSizeSetting As definições de dimensionamento automático para a moldura de texto.
bottomMargin Representa margem inferior, em pontos, do quadro de texto.
hasText Especifica se a moldura de texto contém texto.
leftMargin Representa margem esquerda, em pontos, do quadro de texto.
noTextRotation Devolve Verdadeiro se o texto na moldura de texto não for rodado quando a forma for rodada.
orientation Representa o ângulo para o qual o texto é orientado para a moldura de texto.
rightMargin Representa margem direita, em pontos, do quadro de texto.
topMargin Representa margem superior, em pontos, do quadro de texto.
verticalAlignment Representa o alinhamento vertical do quadro de texto.
wordWrap Determina se as linhas quebram automaticamente para se ajustarem ao texto dentro da forma.
Janela activePane 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 desta coleção.
getFirstOrNullObject() Obtém a primeira janela desta coleção.
items Obtém os itens filhos carregados nesta coleção.

Confira também