Word API de versión preliminar de JavaScript
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:
- Debe usar la versión preliminar de la biblioteca de API de JavaScript de Office desde la red de entrega de contenido (CDN) deOffice.js. El tipo de archivo de definición para la compilación TypeScript e IntelliSense se encuentra en la CDN y DefinitelyTyped. Puede instalar estos tipos con
npm install --save-dev @types/office-js-preview(asegúrese de quitar los tipos para@types/office-jssi los ha instalado anteriormente). - Es posible que tenga que unirse al programa Microsoft 365 Insider para acceder a compilaciones de Office más recientes.
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 | insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox") | Ajusta el objeto Body con un control de contenido. |
| ComboBoxContentControl | addListItem(displayText: string, value?: string, index?: number) | Agrega un nuevo elemento de lista a este control de contenido de cuadro combinado y devuelve un Word. Objeto ContentControlListItem. |
| deleteAllListItems() | Elimina todos los elementos de lista de este control de contenido de cuadro combinado. | |
| listItems | Obtiene la colección de elementos de lista en el control de contenido del cuadro combinado. | |
| ContentControl | comboBoxContentControl | Especifica los datos relacionados con el cuadro combinado si el tipo del control de contenido es "ComboBox". |
| dropDownListContentControl | Especifica los datos relacionados con la lista desplegable si el tipo del control de contenido es "DropDownList". | |
| resetState() | Restablece el estado del control de contenido. | |
| setState(contentControlState: Word. ContentControlState) | Establece el estado del control de contenido. | |
| ContentControlListItem | delete() | Elimina el elemento de lista. |
| displayText | Especifica el texto para mostrar de un elemento de lista para un control de contenido de lista desplegable o cuadro combinado. | |
| index | Especifica la ubicación del índice de un elemento de lista de control de contenido en la colección de elementos de lista. | |
| select() | Selecciona el elemento de lista y establece el texto del control de contenido en el valor del elemento de lista. | |
| value | Especifica el valor de programación de un elemento de lista para un control de contenido de lista desplegable o cuadro combinado. | |
| ContentControlListItemCollection | getFirst() | Obtiene el primer elemento de lista de esta colección. |
| getFirstOrNullObject() | Obtiene el primer elemento de lista de esta colección. | |
| items | Obtiene los elementos secundarios cargados en esta colección. | |
| Documento | compareFromBase64(base64File: string, documentCompareOptions?: Word. DocumentCompareOptions) | Muestra las marcas de revisión para indicar dónde están las diferencias entre ambos documentos. |
| DropDownListContentControl | addListItem(displayText: string, value?: string, index?: number) | Agrega un nuevo elemento de lista a este control de contenido de lista desplegable y devuelve un Word. Objeto ContentControlListItem. |
| deleteAllListItems() | Elimina todos los elementos de lista de este control de contenido de lista desplegable. | |
| listItems | Obtiene la colección de elementos de lista del control de contenido de lista desplegable. | |
| Font | hidden | Especifica un valor que indica si la fuente está etiquetada como oculta. |
| Paragraph | insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox") | Ajusta el objeto Paragraph con un control de contenido. |
| Rango | insertContentControl(contentControlType?: Word. ContentControlType.richText | Word. ContentControlType.plainText | Word. ContentControlType.checkBox | Word. ContentControlType.dropDownList | Word. ContentControlType.comboBox | "RichText" | "PlainText" | "CheckBox" | "DropDownList" | "ComboBox") | Ajusta el objeto Range con un control de contenido. |
| Estilo | description | Obtiene la descripción del estilo especificado. |
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. |