Compartir a través de

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
Cuerpo shapes Obtiene la colección de objetos de forma en el cuerpo, incluidas las formas insertadas y flotantes.
type Obtiene el tipo del cuerpo.
Canvas id Obtiene un entero que representa el identificador del lienzo.
shape Obtiene el objeto Shape asociado al lienzo.
shapes Obtiene la colección de objetos Shape.
ContentControl resetState() Restablece el estado del control de contenido.
setState(contentControlState: Word. ContentControlState) Establece el estado del control de contenido.
ContentControlAddedEventArgs eventType El tipo de evento.
ContentControlDataChangedEventArgs eventType El tipo de evento.
ContentControlDeletedEventArgs eventType El tipo de evento.
ContentControlEnteredEventArgs eventType El tipo de evento.
ContentControlExitedEventArgs eventType El tipo de evento.
ContentControlSelectionChangedEventArgs eventType El tipo de evento.
Documento activeWindow Obtiene la ventana activa del documento.
compareFromBase64(base64File: string, documentCompareOptions?: Word. DocumentCompareOptions) Muestra las marcas de revisión para indicar dónde están las diferencias entre ambos documentos.
Windows Obtiene la colección de Word.Window objetos para el documento.
Font hidden Especifica un valor que indica si la fuente está etiquetada como oculta.
InsertShapeOptions height Representa el alto de la forma que se va a insertar.
left Representa la posición izquierda de la forma que se va a insertar.
top Representa la posición superior de la forma que se va a insertar.
width Representa el ancho de la forma que se va a insertar.
Page getNext() Obtiene la página siguiente del panel.
getNextOrNullObject() Obtiene la página siguiente.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | "Entero" | "Iniciar" | "End") Obtiene toda la página, o el punto inicial o final de la página, como un intervalo.
height Obtiene el alto, en puntos, del papel definido en el cuadro de diálogo Configurar página.
index Obtiene el índice de la página.
width Obtiene el ancho, en puntos, del papel definido en el cuadro de diálogo Configurar página.
PageCollection getFirst() Obtiene la primera página de esta colección.
getFirstOrNullObject() Obtiene la primera página de esta colección.
getItem(index: number) Obtiene un objeto Page por su índice en la colección.
items Obtiene los elementos secundarios cargados en esta colección.
Panel getNext() Obtiene el panel siguiente de la ventana.
getNextOrNullObject() Obtiene el panel siguiente.
pages Obtiene la colección de páginas del panel.
pagesEnclosingViewport Obtiene el que PageCollection se muestra en la ventanilla del panel.
PaneCollection getFirst() Obtiene el primer panel de esta colección.
getFirstOrNullObject() Obtiene el primer panel de esta colección.
getItem(index: number) Obtiene un objeto Pane por su índice en la colección.
items Obtiene los elementos secundarios cargados en esta colección.
Paragraph insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Inserta un lienzo flotante delante del texto con su delimitador al principio del párrafo.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Inserta una forma geométrica delante del texto con su delimitador al principio del párrafo.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Inserta una imagen flotante delante del texto con su delimitador al principio del párrafo.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Inserta un cuadro de texto flotante delante del texto con su delimitador al principio del párrafo.
shapes Obtiene la colección de objetos de forma delimitados en el párrafo, incluidas las formas insertadas y flotantes.
ParagraphAddedEventArgs type El tipo de evento.
ParagraphChangedEventArgs type El tipo de evento.
ParagraphDeletedEventArgs type El tipo de evento.
Rango insertCanvas(insertShapeOptions?: Word. InsertShapeOptions) Inserta un lienzo flotante delante del texto con su delimitador al principio del intervalo.
insertGeometricShape(geometricShapeType: Word. GeometricShapeType, insertShapeOptions?: Word. InsertShapeOptions) Inserta una forma geométrica delante del texto con su delimitador al principio del intervalo.
insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word. InsertShapeOptions) Inserta una imagen flotante delante del texto con su delimitador al principio del intervalo.
insertTextBox(text?: string, insertShapeOptions?: Word. InsertShapeOptions) Inserta un cuadro de texto flotante delante del texto con su delimitador al principio del intervalo.
pages Obtiene la colección de páginas del intervalo.
shapes Obtiene la colección de objetos de forma delimitados en el intervalo, incluidas las formas insertadas y flotantes.
Shape body Representa el objeto de cuerpo de la forma.
lona Obtiene el lienzo asociado a la forma.
delete() Elimina la forma y su contenido.
fill Devuelve el formato de relleno de esta forma.
geometricShapeType Tipo de forma geométrica de la forma.
height Alto, en puntos, de la forma.
id Obtiene un entero que representa el identificador de forma.
isChild Compruebe si esta forma es secundaria de una forma de grupo o de lienzo.
left La distancia, en puntos, desde el lado izquierdo de la forma hasta la posición relativa horizontal, vea Word. RelativeHorizontalPosition.
moveHorizontally(distance: number) Mueve la forma horizontalmente por el número de puntos.
moveVertically(distance: number) Mueve la forma verticalmente por el número de puntos.
name Nombre de la forma.
parentCanvas Obtiene la forma del lienzo primario de nivel superior de esta forma secundaria.
parentGroup Obtiene la forma de grupo primario de nivel superior de esta forma secundaria.
relativeHorizontalPosition Posición horizontal relativa de la forma.
relativeVerticalPosition Posición vertical relativa de la forma.
select(selectMultipleShapes?: boolean) Selecciona la forma.
shapeGroup Obtiene el grupo de formas asociado a la forma.
textFrame Obtiene el objeto de marco de texto de la forma.
top La distancia, en puntos, desde el borde superior de la forma hasta la posición relativa vertical, vea Word. RelativeVerticalPosition.
type Obtiene el tipo de forma.
width Ancho, en puntos, de la forma.
ShapeCollection getByGeometricTypes(types: Word. GeometricShapeType[]) Obtiene las formas que tienen los tipos geométricos especificados.
getById(id: number) Obtiene una forma por su identificador.
getByIdOrNullObject(id: number) Obtiene una forma por su identificador.
getByIds(ids: number[]) Obtiene las formas por los identificadores.
getByNames(names: string[]) Obtiene las formas que tienen los nombres especificados.
getByTypes(types: Word. ShapeType[]) Obtiene las formas que tienen los tipos especificados.
getFirst() Obtiene la primera forma de esta colección.
getFirstOrNullObject() Obtiene la primera forma de esta colección.
group() Se omitirán las formas flotantes de grupos de esta colección.
items Obtiene los elementos secundarios cargados en esta colección.
ShapeFill backgroundColor Especifica el color de fondo de relleno de forma.
clear() Borra el formato de relleno de esta forma y la Word.ShapeFillType.NoFillestablece en ;
foregroundColor Especifica el color de primer plano del relleno de formas.
setSolidColor(color: string) Establece el formato de relleno de la forma en un color uniforme.
transparency Especifica el porcentaje de transparencia del relleno como un valor de 0,0 (opaco) a 1,0 (claro).
type Devuelve el tipo de relleno de la forma.
ShapeGroup id Obtiene un entero que representa el identificador del grupo de formas.
shape Obtiene el objeto Shape asociado al grupo.
shapes Obtiene la colección de objetos Shape.
ungroup() Desagrupa las formas agrupadas en el grupo de formas especificado.
Estilo description Obtiene la descripción del estilo especificado.
TextFrame autoSizeSetting La configuración de ajuste de tamaño automático para el marco de texto.
bottomMargin Indica el margen inferior, en puntos, del marco de texto.
hasText Especifica si el marco de texto contiene texto.
leftMargin Indica el margen izquierdo, en puntos, del marco de texto.
noTextRotation Devuelve True si el texto del marco de texto no debe girar cuando se gira la forma.
orientation Representa el ángulo al que está orientado el texto para el marco de texto.
rightMargin Indica el margen derecho, en puntos, del marco de texto.
topMargin Indica el margen superior, en puntos, del marco de texto.
verticalAlignment Indica la alineación vertical del marco de texto.
wordWrap Determina si las líneas se interrumpen automáticamente para ajustar el texto dentro de la forma.
Window activePane Obtiene el panel activo de la ventana.
Paneles Obtiene la colección de paneles de la ventana.
WindowCollection getFirst() Obtiene la primera ventana de esta colección.
getFirstOrNullObject() Obtiene la primera ventana de esta colección.
getItem(index: number) Obtiene un objeto Window por su índice en la colección.
items Obtiene los elementos secundarios cargados en esta colección.

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.
Rango 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