Compartir a través de

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, es posible que varias API solo estén disponibles en Word en la 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. 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.
type Obtiene el tipo del cuerpo.
BookmarkCollection add(name: string, range: Word. Rango) Devuelve un Bookmark objeto que representa un marcador agregado a un intervalo.
getItem(index: number) Obtiene un Bookmark objeto por su índice en la colección.
BorderUniversalCollection getItem(index: number) Obtiene un Border objeto por su índice en la colección.
CommentDetail id Representa el identificador de este comentario.
replyIds Representa los identificadores de las respuestas a este comentario.
CommentEventArgs changeType Representa cómo se genera el commentChanged evento.
commentDetails Obtiene la CommentDetail matriz que contiene los identificadores y los identificadores de respuesta de los comentarios implicados.
source Especifica el origen del evento.
type Especifica el tipo de evento.
ConflictCollection getItem(index: number) Obtiene un Conflict objeto por su índice en la colección.
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.
resetState() Restablece el estado del control de contenido.
setState(contentControlState: Word. ContentControlState) Establece el estado del control de contenido.
CustomXmlAddValidationErrorOptions clearedOnUpdate Si se proporciona, especifica si el error se va a borrar de la Word. CustomXmlValidationErrorCollection cuando se corrige y actualiza el XML.
errorText Si se proporciona, especifica el texto descriptivo del error.
CustomXmlNodeCollection getItem(index: number) Devuelve un CustomXmlNode objeto que representa el elemento especificado en la colección.
Customxmlpart errors Obtiene un CustomXmlValidationErrorCollection objeto que proporciona acceso a los errores de validación XML.
CustomXmlPrefixMappingCollection getItem(index: number) Devuelve un CustomXmlPrefixMapping objeto que representa el elemento especificado en la colección.
CustomXmlValidationError delete() Elimina este CustomXmlValidationError objeto.
errorCode Obtiene un entero que representa el error de validación en el CustomXmlValidationError objeto .
name Obtiene el nombre del error en el CustomXmlValidationError objeto .
Nodo Obtiene el nodo asociado a este CustomXmlValidationError objeto, si existe.
text Obtiene el texto del CustomXmlValidationError objeto .
type Obtiene el tipo de error generado a partir del CustomXmlValidationError objeto .
CustomXmlValidationErrorCollection add(node: Word. CustomXmlNode, errorName: string, options?: Word. CustomXmlAddValidationErrorOptions) Agrega un CustomXmlValidationError objeto que contiene un error de validación XML al CustomXmlValidationErrorCollection objeto .
getCount() Devuelve el número de elementos de la colección.
getItem(index: number) Devuelve un CustomXmlValidationError objeto que representa el elemento especificado en la colección.
items Obtiene los elementos secundarios cargados en esta colección.
Documento checkIn(options?: Word. DocumentCheckInOptions) Comprueba el documento desde el equipo local a un servidor y establece el documento local en de solo lectura para que no se pueda editar localmente.
checkInWithVersion(options?: Word. DocumentCheckInWithVersionOptions) Guarda el documento en un servidor desde un equipo local y establece el documento local en solo lectura para que no se pueda editar localmente.
checkSpelling(options?: Word. DocumentCheckSpellingOptions) Comienza una revisión ortográfica del documento.
computeStatistics(statistic: Word. StatisticType, includeFootnotesAndEndnotes?: boolean) Devuelve una estadística basada en el contenido del documento.
countNumberedItems(options?: Word. DocumentCountNumberedItemsOptions) Devuelve el número de elementos con viñetas o numerados y los campos LISTNUM del documento.
endReview(options?: Word. DocumentEndReviewOptions) Finaliza una revisión del archivo que se ha enviado para su revisión.
exportAsFixedFormat(outputFileName: string, exportFormat: Word. ExportFormat, options?: Word. DocumentExportAsFixedFormatOptions) Guarda el documento en formato PDF o XPS.
exportAsFixedFormat2(outputFileName: string, exportFormat: Word. ExportFormat, options?: Word. DocumentExportAsFixedFormat2Options) Guarda el documento en formato PDF o XPS.
exportAsFixedFormat3(outputFileName: string, exportFormat: Word. ExportFormat, options?: Word. DocumentExportAsFixedFormat3Options) Guarda el documento en formato PDF o XPS con un etiquetado mejorado.
followHyperlink(options?: Word. DocumentFollowHyperlinkOptions) Muestra un documento almacenado en memoria caché, si ya se ha descargado.
getRange(options?: Word. DocumentRangeOptions) Devuelve un Range objeto mediante las posiciones de caracteres inicial y final especificadas.
goTo(options?: Word. GoToOptions) Devuelve un Range objeto que representa la posición inicial del elemento especificado, como una página, un marcador o un campo.
merge(fileName: string, options?: Word. DocumentMergeOptions) Combina los cambios marcados con marcas de revisión de un documento en otro documento.
printOut(options?: Word. DocumentPrintOutOptions) Imprime todo o parte del documento.
protect(type: Word. ProtectionType, options?: Word. DocumentProtectOptions) Protege el documento frente a cambios no autorizados.
replyWithChanges(options?: Word. DocumentReplyWithChangesOptions) Envía un mensaje de correo electrónico al autor del documento que se ha enviado para su revisión, notificándole que un revisor ha completado la revisión del documento.
sendFaxOverInternet(options?: Word. DocumentSendFaxOverInternetOptions) Envía el documento a un proveedor de servicios de fax, que envía el documento por fax a uno o varios destinatarios especificados.
sendForReview(options?: Word. DocumentSendForReviewOptions) Envía el documento en un mensaje de correo electrónico para que lo revisen los destinatarios especificados.
DocumentCheckInOptions comment Si se proporciona, especifica un comentario para la operación de protección.
makePublic Si se proporciona, especifica si se debe hacer público el documento después de la protección.
saveChanges Si se proporciona, especifica si se deben guardar los cambios antes de realizar la comprobación.
DocumentCheckInWithVersionOptions comment Si se proporciona, especifica un comentario para la operación de protección.
makePublic Si se proporciona, especifica si se debe hacer público el documento después de la protección.
saveChanges Si se proporciona, especifica si se deben guardar los cambios antes de realizar la comprobación.
versionType Si se proporciona, especifica el tipo de versión para la protección.
DocumentCheckSpellingOptions alwaysSuggest Si se proporciona, especifica si se deben sugerir siempre correcciones ortográficas.
customDictionary10 Si se proporciona, especifica un diccionario personalizado adicional que se usará para la revisión ortográfica.
customDictionary2 Si se proporciona, especifica un diccionario personalizado adicional que se usará para la revisión ortográfica.
customDictionary3 Si se proporciona, especifica un diccionario personalizado adicional que se usará para la revisión ortográfica.
customDictionary4 Si se proporciona, especifica un diccionario personalizado adicional que se usará para la revisión ortográfica.
customDictionary5 Si se proporciona, especifica un diccionario personalizado adicional que se usará para la revisión ortográfica.
customDictionary6 Si se proporciona, especifica un diccionario personalizado adicional que se usará para la revisión ortográfica.
customDictionary7 Si se proporciona, especifica un diccionario personalizado adicional que se usará para la revisión ortográfica.
customDictionary8 Si se proporciona, especifica un diccionario personalizado adicional que se usará para la revisión ortográfica.
customDictionary9 Si se proporciona, especifica un diccionario personalizado adicional que se usará para la revisión ortográfica.
customDictionary Si se proporciona, especifica el diccionario personalizado que se usará para la revisión ortográfica.
ignoreUppercase Si se proporciona, especifica si se deben omitir las palabras mayúsculas durante la revisión ortográfica.
DocumentCountNumberedItemsOptions level Si se proporciona, especifica el nivel de numeración que se va a contar.
numberType Si se proporciona, especifica el tipo de elementos numerados que se van a contar.
DocumentEndReviewOptions includeAttachment Si se proporciona, especifica si se debe incluir el documento como datos adjuntos.
recipients Si se proporciona, especifica los destinatarios a los que se va a notificar al finalizar la revisión.
Showmessage Si se proporciona, especifica si se debe mostrar el mensaje antes de enviarlo.
subject Si se proporciona, especifica el asunto del correo electrónico de notificación.
DocumentExportAsFixedFormat2Options bitmapMissingFonts Si se proporciona, especifica si faltan fuentes en el mapa de bits.
createBookmarks Si se proporciona, especifica el modo de creación de marcadores.
documentStructureTags Si se proporciona, especifica si se deben incluir etiquetas de estructura de documento.
fixedFormatExtClassPtr Si se proporciona, especifica el puntero de clase de extensión.
from Si se proporciona, especifica el número de página inicial.
includeDocProps Si se proporciona, especifica si se deben incluir las propiedades del documento.
elemento Si se proporciona, especifica el elemento que se va a exportar.
keepInformationRightsManagement Si se proporciona, especifica si se debe mantener la configuración de Information Rights Management (IRM).
openAfterExport Si se proporciona, especifica si se va a abrir el archivo después de la exportación.
optimizeFor Si se proporciona, especifica el destino de optimización para la exportación.
optimizeForImageQuality Si se proporciona, especifica si se debe optimizar la calidad de la imagen en el archivo exportado.
range Si se proporciona, especifica el intervalo que se va a exportar.
to Si se proporciona, especifica el número de página final.
useIso19005_1 Si se proporciona, especifica si se debe usar el cumplimiento iso 19005-1.
DocumentExportAsFixedFormat3Options bitmapMissingFonts Si se proporciona, especifica si faltan fuentes en el mapa de bits.
createBookmarks Si se proporciona, especifica el modo de creación de marcadores.
documentStructureTags Si se proporciona, especifica si se deben incluir etiquetas de estructura de documento.
fixedFormatExtClassPtr Si se proporciona, especifica el puntero de clase de extensión.
from Si se proporciona, especifica el número de página inicial.
improveExportTagging Si se proporciona, especifica que se mejore el etiquetado de exportación para mejorar la accesibilidad.
includeDocProps Si se proporciona, especifica si se deben incluir las propiedades del documento.
elemento Si se proporciona, especifica el elemento que se va a exportar.
keepInformationRightsManagement Si se proporciona, especifica si se debe mantener la configuración de Information Rights Management (IRM).
openAfterExport Si se proporciona, especifica si se va a abrir el archivo después de la exportación.
optimizeFor Si se proporciona, especifica el destino de optimización para la exportación.
optimizeForImageQuality Si se proporciona, especifica si se debe optimizar la calidad de la imagen en el archivo exportado.
range Si se proporciona, especifica el intervalo que se va a exportar.
to Si se proporciona, especifica el número de página final.
useIso19005_1 Si se proporciona, especifica si se debe usar el cumplimiento iso 19005-1.
DocumentExportAsFixedFormatOptions bitmapMissingFonts Si se proporciona, especifica si faltan fuentes en el mapa de bits.
createBookmarks Si se proporciona, especifica el modo de creación de marcadores.
documentStructureTags Si se proporciona, especifica si se deben incluir etiquetas de estructura de documento.
fixedFormatExtensionClassPointer Si se proporciona, especifica el puntero de clase de extensión.
from Si se proporciona, especifica el número de página inicial.
includeDocProps Si se proporciona, especifica si se deben incluir las propiedades del documento.
elemento Si se proporciona, especifica el elemento que se va a exportar.
keepInformationRightsManagement Si se proporciona, especifica si se debe mantener la configuración de Information Rights Management (IRM).
openAfterExport Si se proporciona, especifica si se va a abrir el archivo después de la exportación.
optimizeFor Si se proporciona, especifica el destino de optimización para la exportación.
range Si se proporciona, especifica el intervalo que se va a exportar.
to Si se proporciona, especifica el número de página final.
useIso19005_1 Si se proporciona, especifica si se debe usar el cumplimiento iso 19005-1.
DocumentFollowHyperlinkOptions addHistory Si se proporciona, especifica si se debe agregar el vínculo al historial de exploración.
address Si se proporciona, especifica la dirección del hipervínculo que se va a seguir.
extraInfo Si se proporciona, especifica información adicional que se pasará con la solicitud.
headerInfo Si se proporciona, especifica la información de encabezado de la solicitud HTTP.
httpMethod Si se proporciona, especifica el método HTTP que se usará para la solicitud.
Newwindow Si se proporciona, especifica si se va a abrir el vínculo en una nueva ventana.
Subdirección Si se proporciona, especifica la subdireccionamiento dentro del documento.
DocumentMergeOptions addToRecentFiles Si se proporciona, especifica si se va a agregar el documento combinado a archivos recientes.
detectFormatChanges Si se proporciona, especifica si se deben detectar cambios de formato durante la combinación.
mergeTarget Si se proporciona, especifica el destino de la operación de combinación.
useFormattingFrom Si se proporciona, especifica el origen de formato que se va a usar en la combinación.
DocumentPrintOutOptions activePrinterMacGX Si se proporciona, especifica el nombre de la impresora.
Anexar Si se proporciona, especifica si se va a anexar a un archivo existente.
Fondo Si se proporciona, especifica si se va a imprimir en segundo plano.
Collate Si se proporciona, especifica si se deben intercalar páginas.
Copias Si se proporciona, especifica el número de copias que se van a imprimir.
from Si se proporciona, especifica el número de página inicial.
elemento Si se proporciona, especifica el elemento que se va a imprimir.
manualDuplexPrint Si se proporciona, especifica si se debe imprimir manualmente dúplex.
outputFileName Si se proporciona, especifica el nombre del archivo de salida.
pageType Si se proporciona, especifica el orden de la página.
pages Si se proporciona, especifica páginas específicas que se van a imprimir.
printToFile Si se proporciona, especifica si se va a imprimir en el archivo.
printZoomColumn Si se proporciona, especifica la configuración de la columna de zoom.
printZoomPaperHeight Si se proporciona, especifica el alto del papel para imprimir en twips (20 twips = 1 punto; 72 puntos = 1 pulgada).
printZoomPaperWidth Si se proporciona, especifica el ancho del papel para imprimir en twips (20 twips = 1 punto; 72 puntos = 1 pulgada).
printZoomRow Si se proporciona, especifica la configuración de fila de zoom.
range Si se proporciona, especifica el intervalo que se va a imprimir.
to Si se proporciona, especifica el número de página final.
DocumentProtectOptions enforceStyleLock Si se proporciona, especifica si se deben aplicar restricciones de bloqueo de estilo.
noReset Si se proporciona, especifica si se deben restablecer los campos de formulario al proteger el documento.
password Si se proporciona, especifica la contraseña que se va a aplicar para la protección de documentos.
useInformationRightsManagement Si se proporciona, especifica si se debe usar Information Rights Management (IRM).
DocumentRangeOptions end Si se proporciona, especifica la posición del carácter final.
start Si se proporciona, especifica la posición del carácter inicial.
DocumentReplyWithChangesOptions includeAttachment Si se proporciona, especifica si se debe incluir el documento como datos adjuntos.
recipients Si se proporciona, especifica los destinatarios de la respuesta.
Showmessage Si se proporciona, especifica si se debe mostrar el mensaje antes de enviarlo.
subject Si se proporciona, especifica el asunto del correo electrónico de respuesta.
DocumentSendFaxOverInternetOptions recipients Si se proporciona, especifica los destinatarios del fax.
Showmessage Si se proporciona, especifica si se debe mostrar el mensaje antes de enviarlo.
subject Si se proporciona, especifica el asunto del fax.
DocumentSendForReviewOptions includeAttachment Si se proporciona, especifica si se debe incluir el documento como datos adjuntos.
recipients Si se proporciona, especifica los destinatarios de la solicitud de revisión.
Showmessage Si se proporciona, especifica si se debe mostrar el mensaje antes de enviarlo.
subject Si se proporciona, especifica el asunto del correo electrónico de revisión.
GoToOptions count Si se proporciona, especifica el número del elemento en el documento.
direction Si se proporciona, especifica la dirección a la que se mueve el intervalo o la selección.
elemento Si se proporciona, especifica el tipo de elemento al que se mueve el intervalo o la selección.
name Si se proporciona, especifica el nombre si la item propiedad está establecida en Word. Tipo GoToItem bookmark, comment, fieldo object.
IndexCollection getItem(index: number) Obtiene un Index objeto por su índice en la colección.
ListTemplateAddOptions name Si se proporciona, especifica el nombre de la plantilla de lista que se va a agregar.
outlineNumbered Si se proporciona, especifica si se debe aplicar la numeración de esquema a la nueva plantilla de lista.
ListTemplateCollection add(options?: Word. ListTemplateAddOptions) Agrega un nuevo ListTemplate objeto.
getItem(index: number) Obtiene un ListTemplate objeto por su índice en la colección.
ListTemplateGalleryCollection getItem(index: number) Obtiene un ListTemplateGallery objeto por su índice en la colección.
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.
underline Especifica el tipo de subrayado aplicado al intervalo.
RangeScopedCollection getItem(index: number) Obtiene un Range objeto por su índice en la colección.
RepeatingSectionContentControl xmlMapping Devuelve un XmlMapping objeto que representa la asignación del control de contenido a los datos XML del almacén de datos del documento.
ReviewerCollection getItem(index: number) Devuelve un Reviewer objeto que representa el elemento especificado en la colección.
RevisionCollection getItem(index: number) Devuelve un Revision objeto que representa el elemento especificado en la colección.
Selection convertToTable(options?: Word. SelectionConvertToTableOptions) Convierte texto dentro de un intervalo en una tabla.
goTo(options?: Word. GoToOptions) Devuelve un Range objeto que representa el área especificada por options y mueve el punto de inserción a la posición de carácter inmediatamente anterior al elemento especificado.
SelectionConvertToTableOptions applyBorders Si se proporciona, especifica si se deben aplicar bordes a la tabla del formato especificado.
applyColor Si se proporciona, especifica si se debe aplicar formato de color a la tabla del formato especificado.
applyFirstColumn Si se proporciona, especifica si se debe aplicar formato especial a la primera columna del formato especificado.
applyFont Si se proporciona, especifica si se va a aplicar el formato de fuente a la tabla del formato especificado.
applyHeadingRows Si se proporciona, especifica si se debe dar formato a la primera fila como una fila de encabezado del formato especificado.
applyLastColumn Si se proporciona, especifica si se debe aplicar formato especial a la última columna del formato especificado.
applyLastRow Si se proporciona, especifica si se debe aplicar formato especial a la última fila del formato especificado.
applyShading Si se proporciona, especifica si se debe aplicar el sombreado a la tabla del formato especificado.
Autoajustar Si se proporciona, especifica si se debe cambiar automáticamente el tamaño de la tabla para que se ajuste al contenido.
autoFitBehavior Si se proporciona, especifica el comportamiento de ajuste automático de la tabla.
defaultTableBehavior Si se proporciona, especifica si Microsoft Word cambia automáticamente el tamaño de las celdas de una tabla para que se ajusten al contenido.
format Si se proporciona, especifica un formato preestablecido que se aplicará a la tabla.
initialColumnWidth Si se proporciona, especifica el ancho inicial de cada columna de la tabla, en puntos.
numColumns Si se proporciona, especifica el número de columnas de la tabla.
numRows Si se proporciona, especifica el número de filas de la tabla.
Separador Si se proporciona, especifica el carácter usado para separar el texto en celdas.
SourceCollection getItem(index: number) Obtiene un objeto Source por su índice en la colección.
Estilo description Obtiene la descripción del estilo.
TabStopCollection getItem(index: number) Obtiene un TabStop objeto por su índice en la colección.
Window state Especifica el estado de la ventana de documento o de la ventana de tareas.
Xmlnode type Obtiene el tipo de nodo.
value Especifica el valor de este nodo XML.
XmlNodeCollection getItem(index: number) Obtiene un XmlNode objeto por su índice en la colección.

Vea también

  • Last updated on