Compartir a través de

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

  • Artículo

El WordApiDesktop conjunto de requisitos es un conjunto de requisitos especial 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 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 WordApiDesktop conjunto de requisitos se admiten en 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 etiquetadas en este WordApiDesktop conjunto de requisitos. Para 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 de solo 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 de solo escritorio en una plataforma no admitida.

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

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

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 Word incluidas actualmente en el conjunto de WordApiDesktop 1.1 requisitos. Para obtener una lista completa de todas las API de JavaScript Word (incluidas WordApiDesktop 1.1 las API y las API publicadas anteriormente), consulte todas las API de JavaScript Word.

Clase Campos Descripción
Border color Especifica el color del borde.
location Obtiene la ubicación del borde.
type Especifica el tipo de borde para el borde.
visible Especifica si el borde está visible.
width Especifica el ancho del borde.
BorderCollection getByLocation(borderLocation: Word.BorderLocation.top | Word. BorderLocation.left | Word. BorderLocation.bottom | Word. BorderLocation.right | Word. BorderLocation.insideHorizontal | Word. BorderLocation.insideVertical | "Top" | "Left" | "Abajo" | "Derecho" | "InsideHorizontal" | "InsideVertical") Obtiene el borde 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 objeto Border 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 desde una cadena con formato JSON.
DocumentCompareOptions addToRecentFiles True agrega el documento a la lista de archivos usados recientemente en el menú archivo.
authorName Nombre del revisor asociado con las diferencias generadas en la comparación.
compareTarget El documento de destino para la comparación.
detectFormatChanges Es true (valor predeterminado) para que la comparación detecte también los cambios de formato.
ignoreAllComparisonWarnings True compara los documentos sin notificar a un usuario de problemas.
removeDateAndTime True quita la información de marca de fecha y hora de los cambios realizados en el objeto Document.
removePersonalInformation True quita toda la información del usuario de los comentarios, las revisiones y el cuadro de diálogo de propiedades del objeto Document devuelto.
Field showCodes Especifica si se muestran los códigos de campo para el campo especificado.
InlinePicture imageFormat Obtiene el formato de la imagen insertada.
Lista getLevelFont(level: number) Obtiene la fuente de la viñeta, el número o la imagen en el nivel especificado de la lista.
getLevelPicture(level: number) Obtiene la representación de cadena codificada en Base64 de la imagen en el nivel especificado de la lista.
resetLevelFont(level: number, resetFontName?: boolean) Restablece la fuente de la viñeta, el número o la imagen en el nivel especificado de la lista.
setLevelPicture(level: number, base64EncodedImage?: string) Establece la imagen en el nivel especificado de la lista.
ListLevel alineación Especifica la alineación horizontal del nivel de lista.
font Obtiene un objeto Font que representa el formato de caracteres del objeto especificado.
linkedStyle Especifica el nombre del estilo vinculado al objeto de nivel de lista especificado.
numberFormat Especifica el formato de número para el nivel de lista especificado.
numberPosition Especifica la posición (en puntos) del número o viñeta del objeto de nivel de lista especificado.
numberStyle Especifica el estilo de número para el objeto de nivel de lista.
resetOnHigher Especifica el nivel de lista que debe aparecer antes de que el nivel de lista especificado reinicie la numeración en 1.
startAt Especifica el número inicial del objeto de nivel de lista especificado.
tabPosition Especifica la posición de tabulación del objeto de nivel de lista especificado.
textPosition Especifica la posición (en puntos) de la segunda línea de ajuste de texto para el objeto de nivel de lista especificado.
trailingCharacter Especifica el carácter insertado después del número para el nivel de lista especificado.
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 listLevels Obtiene una colección ListLevels que representa todos los niveles de la clase ListTemplate especificada.
outlineNumbered Especifica si el objeto ListTemplate especificado está numerado.
Shading foregroundPatternColor Especifica el color del primer plano del objeto.
textura Especifica la textura de sombreado del objeto.
Estilo borders Especifica un objeto BorderCollection que representa todos los bordes del estilo especificado.
listTemplate Obtiene un objeto ListTemplate que representa el formato de lista para el objeto Style especificado.
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 con un estilo especificado se dividen entre páginas.

Vea también