Conjunto de requisitos de solo escritorio de la API de JavaScript de Word 1.1

El WordApiDesktop conjunto de requisitos es un conjunto de requisitos especiales que incluye características que solo están disponibles para Word en Windows, Mac y iPad. Las API de este conjunto de requisitos se consideran API de producción para la aplicación de Word en Windows, en Mac y en iPad. Siguen las directivas de soporte técnico para desarrolladores de Microsoft 365. WordApiDesktop Las API se consideran API de "versión preliminar" para otras plataformas (web) y es posible que no sean compatibles con ninguna de esas plataformas.

Cuando las API del conjunto de WordApiDesktop requisitos sean compatibles con todas las plataformas, se agregarán al siguiente conjunto de requisitos publicado (WordApi 1.[NEXT]). Una vez que el nuevo conjunto de requisitos sea público, esas API también seguirán etiquetándose en este WordApiDesktop conjunto de requisitos. Para obtener más información sobre los requisitos específicos de la plataforma en general, consulte Descripción de los conjuntos de requisitos específicos de la plataforma.

Importante

WordApiDesktop 1.1 es un conjunto de requisitos solo para escritorio. Es un superconjunto de WordApi 1.8.

Dado que las WordApiDesktop 1.1 API solo son compatibles con Word en Windows, en Mac y en iPad, el complemento debe comprobar si el conjunto de requisitos es compatible antes de llamar a estas API. Esto evita cualquier intento de usar API solo de escritorio en una plataforma no compatible.

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

Una vez que la API está en un conjunto de requisitos multiplataforma, debe quitar o editar la isSetSupported comprobación. Esto habilitará la característica del complemento en otras plataformas. Al realizar este cambio, asegúrate de probar la característica en esas plataformas.

Importante

El manifiesto no se puede especificar WordApiDesktop 1.1 como requisito de activación. No es un valor válido para usar en el elemento Set.

Lista de API

En la tabla siguiente se enumeran las API de JavaScript de Word incluidas actualmente en el conjunto de WordApiDesktop 1.1 requisitos. Para obtener una lista completa de todas las API de JavaScript de Word (incluidas las API y WordApiDesktop 1.1 las API publicadas anteriormente), consulte todas las API de JavaScript de Word.

Clase Campos Descripción
Border color Especifica el color del borde.
location Obtiene la ubicación de la frontera.
type Especifica el tipo de borde para el borde.
visible Especifica si el borde es visible.
width Especifica el ancho del borde.
Colección de bordes getByLocation(borderLocation: Word.BorderLocation.top | Word. BorderLocation.left | Word. BorderLocation.bottom | Word. BorderLocation.right | Word. BorderLocation.insideHorizontal | Word. BorderLocation.insideVertical | "Arriba" | "Izquierda" | "Abajo" | "Correcto" | "InteriorHorizontal" | "InsideVertical") Obtiene la frontera que tiene la ubicación especificada.
getFirst() Obtiene el primer borde de esta colección.
getFirstOrNullObject() Obtiene el primer borde de esta colección.
getItem(index: number) Obtiene un Border objeto por su índice en la colección.
insideBorderColor Especifica el color de 24 bits de los bordes interiores.
insideBorderType Especifica el tipo de borde de los bordes interiores.
insideBorderWidth Especifica el ancho de los bordes interiores.
items Obtiene los elementos secundarios cargados en esta colección.
outsideBorderColor Especifica el color de 24 bits de los bordes exteriores.
outsideBorderType Especifica el tipo de borde de los bordes exteriores.
outsideBorderWidth Especifica el ancho de los bordes exteriores.
Documento compare(filePath: string, documentCompareOptions?: Word. DocumentCompareOptions) Muestra las marcas de revisión para indicar dónde están las diferencias entre ambos documentos.
importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word. ImportedStylesConflictBehavior) Importar estilos de una cadena con formato JSON.
DocumentCompareOptions addToRecentFiles Si se proporciona, especifica si se agrega el documento a la lista de archivos utilizados recientemente en el menú Archivo .
authorName Si se proporciona, especifica el nombre del revisor asociado a las diferencias generadas por la comparación.
compareTarget Si se proporciona, especifica el documento de destino para la comparación.
detectFormatChanges Si se proporciona, especifica si la comparación debe incluir la detección de cambios de formato.
ignoreAllComparisonWarnings Si se proporciona, especifica si se van a comparar los documentos sin notificar al usuario de los problemas.
removeDateAndTime Si se proporciona, especifica si se quitará la información de fecha y hora de los cambios realizados en el objeto devuelto Document .
removePersonalInformation Si se proporciona, especifica si se quitará toda la información del usuario de los comentarios, revisiones y el cuadro de diálogo de propiedades del objeto devuelto Document .
Field showCodes Especifica si se muestran los códigos de campo del campo especificado.
InlinePicture formato de imagen Obtiene el formato de la imagen alineada.
Lista getLevelFont(level: number) Obtiene la fuente de la viñeta, el número o la imagen en el nivel especificado en la lista.
getLevelPicture(level: number) Obtiene la representación de cadena codificada en base64 de la imagen en el nivel especificado en la lista.
resetLevelFont(level: number, resetFontName?: boolean) Restablece la fuente de la viñeta, el número o la imagen al nivel especificado en la lista.
setLevelPicture(level: number, base64EncodedImage?: string) Establece la imagen en el nivel especificado en la lista.
Nivel de lista alineación Especifica la alineación horizontal del nivel de lista.
font Obtiene un Font objeto que representa el formato de caracteres del ListLevel objeto.
linkedStyle Especifica el nombre del estilo vinculado al ListLevel objeto.
numberFormat Especifica el formato de número para el nivel de lista.
numberPosition Especifica la posición (en puntos) del número o la viñeta del ListLevel objeto.
numberStyle Especifica el estilo de número del ListLevel objeto.
resetOnHigher Especifica el nivel de lista que debe aparecer antes de que se reinicie la numeración en 1.
startAt Especifica el número inicial del ListLevel objeto.
tabPosition Especifica la posición de tabulación del ListLevel objeto.
textPosition Especifica la posición (en puntos) de la segunda línea de texto de ajuste del ListLevel objeto.
trailingCharacter Especifica el carácter insertado después del número para el nivel de lista.
ListLevelCollection getFirst() Obtiene el primer nivel de lista de esta colección.
getFirstOrNullObject() Obtiene el primer nivel de lista de esta colección.
items Obtiene los elementos secundarios cargados en esta colección.
ListTemplate niveles de lista Obtiene un ListLevelCollection objeto que representa todos los niveles de la plantilla de lista.
outlineNumbered Especifica si la plantilla de lista está numerada como esquema.
Shading foregroundPatternColor Especifica el color del primer plano del objeto.
textura Especifica la textura de sombreado del objeto.
Estilo borders Especifica un BorderCollection objeto que representa todos los bordes del estilo.
listTemplate Obtiene un ListTemplate objeto que representa el formato de lista para el estilo.
TableRow insertContentControl() Inserta un control de contenido en la fila.
TableStyle alineación Especifica la alineación de la tabla con respecto al margen de página.
allowBreakAcrossPage Especifica si las líneas de las tablas con formato de estilo se separan entre las páginas.

Vea también

  • Last updated on