Word o conjunto de requisitos apenas para ambiente de trabalho da API JavaScript 1.1
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.1 é um conjunto de requisitos apenas para ambiente de trabalho. É um superconjunto do WordApi 1.8.
Utilização recomendada
Uma vez que as APIs só são suportadas por Word no Windows, no Mac e no iPad, o WordApiDesktop 1.1 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.1")) {
// 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.1 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.1 conjunto de requisitos. Para obter uma lista completa de todas as APIs JavaScript Word (incluindo WordApiDesktop 1.1 APIs e APIs lançadas anteriormente), veja todas as APIs javaScript Word.
| Classe | Campos | Descrição |
|---|---|---|
| Border | color | Especifica a cor do limite. |
| location | Obtém a localização do limite. | |
| type | Especifica o tipo de limite para o limite. | |
| visible | Especifica se o limite está visível. | |
| width | Especifica a largura do limite. | |
| BorderCollection | getByLocation(borderLocation: Word.BorderLocation.top | Word. BorderLocation.left | Word. BorderLocation.bottom | Word. BorderLocation.right | Word. BorderLocation.insideHorizontal | Word. BorderLocation.insideVertical | "Superior" | "Esquerda" | "Inferior" | "Direita" | "InsideHorizontal" | "InsideVertical") | Obtém o limite que tem a localização especificada. |
| getFirst() | Obtém o primeiro limite nesta coleção. | |
| getFirstOrNullObject() | Obtém o primeiro limite nesta coleção. | |
| getItem(index: number) | Obtém um objeto Limite pelo respetivo índice na coleção. | |
| insideBorderColor | Especifica a cor de 24 bits dos limites interiores. | |
| insideBorderType | Especifica o tipo de limite dos limites interiores. | |
| insideBorderWidth | Especifica a largura dos limites interiores. | |
| items | Obtém os itens filhos carregados nesta coleção. | |
| outsideBorderColor | Especifica a cor de 24 bits dos limites exteriores. | |
| outsideBorderType | Especifica o tipo de limite dos limites exteriores. | |
| outsideBorderWidth | Especifica a largura dos limites exteriores. | |
| Document | compare(filePath: string, documentCompareOptions?: Word. DocumentCompareOptions) | Exibe marcas de revisão que indicam onde o documento especificado difere de um outro documento. |
| DocumentCompareOptions | addToRecentFiles | True adiciona o documento à lista de arquivos recentemente usados no menu arquivo. |
| authorName | O nome do revisor associado com as diferenças geradas pela comparação. | |
| compareTarget | O documento de destino para a comparação. | |
| detectFormatChanges | True (padrão) para a comparação incluir a detecção de mudanças de formato. | |
| ignoreAllComparisonWarnings | True compara os documentos sem notificar o usuário de problemas. | |
| removeDateAndTime | True remove as informações de carimbo de data e hora de alterações controladas no documento objeto retornado. | |
| removePersonalInformation | True remove todas as informações de utilizador de comentários, revisões e a caixa de diálogo propriedades no objeto Documento devolvido. | |
| Campo | showCodes | Especifica se os códigos de campo são apresentados para o campo especificado. |
| InlinePicture | imageFormat | Obtém o formato da imagem inline. |
| List | getLevelFont(nível: número) | Obtém o tipo de letra da marca, número ou imagem no nível especificado na lista. |
| getLevelPicture(nível: número) | Obtém a representação de cadeia codificada com Base64 da imagem no nível especificado na lista. | |
| resetLevelFont(nível: número, resetFontName?: booleano) | Repõe o tipo de letra da marca, número ou imagem no nível especificado na lista. | |
| setLevelPicture(nível: número, base64EncodedImage?: cadeia) | Define a imagem no nível especificado na lista. | |
| ListLevel | alinhamento | Especifica o alinhamento horizontal do nível de lista. |
| font | Obtém um objeto Tipo de Letra que representa a formatação de carateres do objeto especificado. | |
| linkedStyle | Especifica o nome do estilo que está ligado ao objeto de nível de lista especificado. | |
| numberFormat | Especifica o formato de número para o nível de lista especificado. | |
| numberPosition | Especifica a posição (em pontos) do número ou marca de lista para o objeto de nível de lista especificado. | |
| numberStyle | Especifica o estilo de número para o objeto de nível de lista. | |
| resetOnHigher | Especifica o nível de lista que tem de aparecer antes de o nível de lista especificado reiniciar a numeração em 1. | |
| startAt | Especifica o número inicial para o objeto de nível de lista especificado. | |
| tabPosition | Especifica a posição do separador para o objeto de nível de lista especificado. | |
| textPosition | Especifica a posição (em pontos) para a segunda linha de texto de moldagem para o objeto de nível de lista especificado. | |
| trailingCharacter | Especifica o caráter inserido após o número para o nível de lista especificado. | |
| 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 uma coleção ListLevels que representa todos os níveis do ListTemplate especificado. |
| outlineNumbered | Especifica se o objeto ListTemplate especificado está numerado. | |
| Shading | foregroundPatternColor | Especifica a cor do primeiro plano do objeto. |
| textura | Especifica a textura de sombreado do objeto. | |
| Estilo | Borders | Especifica um objeto BorderCollection que representa todos os limites do estilo especificado. |
| listTemplate | Obtém um objeto ListTemplate que representa a formatação da lista para o objeto Estilo especificado. | |
| TableRow | insertContentControl() | Insere um controlo 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 especificado quebram entre páginas. |