Word API de versión preliminar de JavaScript

  • Artículo

Las nuevas API de JavaScript Word se introducen primero en "versión preliminar" y, posteriormente, forman parte de un conjunto de requisitos numerados y específicos después de que se produzcan pruebas suficientes y se adquieran comentarios del usuario.

Importante

Tenga en cuenta que las siguientes API de Word versión preliminar pueden estar disponibles en las siguientes plataformas.

  • Word en Windows
  • Word en Mac

Word API de versión preliminar no se admiten actualmente en iPad. Sin embargo, varias API también pueden estar disponibles en Word en la web. Para las API disponibles solo en Word en la web, consulte la lista api solo web.

Nota:

Las API en versión preliminar están sujetas a cambios y no están pensadas para su uso en un entorno de producción. Le recomendamos que solo las pruebe en entornos de desarrollo y pruebas. No use las API en versión preliminar en un entorno de producción o en documentos críticos para la empresa.

Usar las API en versión preliminar:

Lista de API

En la tabla siguiente se enumeran las API de JavaScript Word actualmente en versión preliminar, excepto las que solo están disponibles en Word en la web. Para ver una lista completa de todas las API de JavaScript Word (incluidas las API de versión preliminar y las API publicadas anteriormente), consulte todas las API de JavaScript Word.

Clase Campos Descripción
AnnotationPopupActionEventArgs action Especifica la acción elegida en el menú emergente.
critiqueSuggestion Especifica la sugerencia aceptada (solo se rellena al aceptar una sugerencia de crítica).
id Especifica el identificador de anotación para el que se ha desencadenado el evento.
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.
ContentControlAddedEventArgs eventType El tipo de evento.
ContentControlDataChangedEventArgs eventType El tipo de evento.
ContentControlDeletedEventArgs eventType El tipo de evento.
ContentControlEnteredEventArgs eventType El tipo de evento.
ContentControlEventArgs contentControl Objeto que generó el evento.
eventType El tipo de evento.
Identificadores Obtiene los identificadores de control de contenido.
source Origen del evento.
ContentControlExitedEventArgs eventType El tipo de evento.
ContentControlSelectionChangedEventArgs eventType El tipo de evento.
Crítica popupOptions Especifica el comportamiento del menú emergente para la crítica.
CritiquePopupOptions brandingTextResourceId Obtiene el identificador de recurso de manifiesto de la cadena que se va a usar para la personalización de marca.
subtitleResourceId Obtiene el identificador de recurso de manifiesto de la cadena que se va a usar como subtítulo.
Sugerencias Obtiene las sugerencias que se van a mostrar en el menú emergente de crítica.
titleResourceId Obtiene el identificador de recurso de manifiesto de la cadena que se va a usar como título.
Documento compare(filePath: string, documentCompareOptions?: Word. DocumentCompareOptions) Muestra las marcas de revisión para indicar dónde están las diferencias entre ambos documentos.
onAnnotationPopupAction Se produce cuando el usuario realiza una acción en un menú emergente de anotación.
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.
Font hidden Especifica un valor que indica si la fuente está etiquetada como oculta.
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.
ParagraphAddedEventArgs type El tipo de evento.
ParagraphChangedEventArgs type El tipo de evento.
ParagraphDeletedEventArgs type El tipo de evento.
Range highlight() Resalta el intervalo temporalmente sin cambiar el contenido del documento.
removeHighlight() Quita el resaltado agregado por la función Highlight si existe.
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.
description Obtiene la descripción 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.

Lista de API de solo web

En la tabla siguiente se enumeran las API de JavaScript Word actualmente en versión preliminar solo en Word en la web. Para ver una lista completa de todas las API de JavaScript Word (incluidas las API de versión preliminar y las API publicadas anteriormente), consulte todas las API de JavaScript Word.

Clase Campos Descripción
Cuerpo onCommentAdded Se produce cuando se agregan nuevos comentarios.
onCommentChanged Se produce cuando se cambia un comentario o su respuesta.
onCommentDeleted Se produce cuando se eliminan los comentarios.
onCommentDeselected Se produce cuando se anula la selección de un comentario.
onCommentSelected Se produce cuando se selecciona un comentario.
CommentDetail id Representa el identificador de este comentario.
replyIds Representa los identificadores de las respuestas a este comentario.
CommentEventArgs changeType Representa cómo se desencadena el evento de cambio de comentario.
commentDetails Obtiene la matriz CommentDetail que contiene los identificadores y los identificadores de respuesta de los comentarios implicados.
source Origen del evento.
type El tipo de evento.
ContentControl onCommentAdded Se produce cuando se agregan nuevos comentarios.
onCommentChanged Se produce cuando se cambia un comentario o su respuesta.
onCommentDeselected Se produce cuando se anula la selección de un comentario.
onCommentSelected Se produce cuando se selecciona un comentario.
Paragraph onCommentAdded Se produce cuando se agregan nuevos comentarios.
onCommentChanged Se produce cuando se cambia un comentario o su respuesta.
onCommentDeleted Se produce cuando se eliminan los comentarios.
onCommentDeselected Se produce cuando se anula la selección de un comentario.
onCommentSelected Se produce cuando se selecciona un comentario.
Range onCommentAdded Se produce cuando se agregan nuevos comentarios.
onCommentChanged Se produce cuando se cambia un comentario o su respuesta.
onCommentDeselected Se produce cuando se anula la selección de un comentario.
onCommentSelected Se produce cuando se selecciona un comentario.

Vea también