Compartir a través de

Novedades de la API de JavaScript de Word 1.3

  • Artículo

WordApi 1.3 agregó más compatibilidad con los controles de contenido y la configuración de nivel de documento.

Lista de API

En la tabla siguiente se enumeran las API de Word conjunto de requisitos de api de JavaScript 1.3. Para ver la documentación de referencia de API para todas las API admitidas por Word conjunto de requisitos de API de JavaScript 1.3 o anterior, consulte Word API en el conjunto de requisitos 1.3 o anterior.

Clase Campos Descripción
Application createDocument(base64File?: string) Crea un nuevo documento mediante un archivo .docx codificado en Base64 opcional.
Cuerpo getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | "Entero" | "Iniciar" | "End" | "Después" | "Contenido") Obtiene el cuerpo completo, o el punto de inicio o fin del cuerpo, como un intervalo.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Iniciar" | "End", values?: string[][]) Inserta una tabla con el número especificado de filas y columnas.
lists Obtiene la colección de objetos de lista en el cuerpo.
parentBody Obtiene el cuerpo primario del cuerpo.
parentBodyOrNullObject Obtiene el cuerpo primario del cuerpo.
parentContentControlOrNullObject Obtiene el control de contenido que contiene el cuerpo.
parentSection Obtiene la sección primaria del cuerpo.
parentSectionOrNullObject Obtiene la sección primaria del cuerpo.
styleBuiltIn Especifica el nombre de estilo integrado para el cuerpo.
Mesas Obtiene la colección de objetos de tabla en el cuerpo.
type Obtiene el tipo del cuerpo.
ContentControl getRange(rangeLocation?: Word. RangeLocation | "Entero" | "Iniciar" | "End" | "Before" | "Después" | "Contenido") Obtiene el control de contenido completo, o el punto inicial o final del control de contenido, como un intervalo.
getTextRanges(endingMarks: string[], trimSpacing?: boolean) Obtiene los intervalos de texto del control de contenido mediante signos de puntuación u otras marcas finales.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Iniciar" | "End" | "Before" | "After", values?: string[][]) Inserta una tabla con el número especificado de filas y columnas en, o junto a, un control de contenido.
lists Obtiene la colección de objetos de lista en el control de contenido.
parentBody Obtiene el cuerpo primario del control de contenido.
parentContentControlOrNullObject Obtiene el control de contenido que contiene el control de contenido.
parentTable Obtiene la tabla que contiene el control de contenido.
parentTableCell Obtiene la celda de tabla que contiene el control de contenido.
parentTableCellOrNullObject Obtiene la celda de tabla que contiene el control de contenido.
parentTableOrNullObject Obtiene la tabla que contiene el control de contenido.
split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean) Divide el control de contenido en intervalos secundarios mediante delimitadores.
styleBuiltIn Especifica el nombre de estilo integrado para el control de contenido.
subtipo Obtiene el subtipo de control de contenido.
Mesas Obtiene la colección de objetos de tabla en el control de contenido.
ContentControlCollection getByIdOrNullObject(id: number) Obtiene un control de contenido mediante su identificador.
getByTypes(types: Word. ContentControlType[]) Obtiene los controles de contenido que tienen los tipos especificados.
getFirst() Obtiene el primer control de contenido de esta colección.
getFirstOrNullObject() Obtiene el primer control de contenido de esta colección.
CustomProperty delete() Elimina la propiedad personalizada.
key Obtiene la clave de la propiedad personalizada.
type Obtiene el tipo de valor de la propiedad personalizada.
value Especifica el valor de la propiedad personalizada.
CustomPropertyCollection add(key: string, value: any) Crea una nueva propiedad personalizada o establece una existente.
deleteAll() Elimina todas las propiedades personalizadas de la colección.
getCount() Obtiene el recuento de las propiedades personalizadas.
getItem(key: string) Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas.
getItemOrNullObject(key: string) Obtiene un objeto de propiedad personalizada mediante su clave, que no distingue mayúsculas de minúsculas.
items Obtiene los elementos secundarios cargados en esta colección.
Documento properties Obtiene las propiedades del documento.
DocumentCreated open() Abre el documento.
DocumentProperties applicationName Obtiene el nombre de aplicación del documento.
autor Especifica el autor del documento.
categoría Especifica la categoría del documento.
comments Especifica el campo Comentarios en los metadatos del documento.
company Especifica la empresa del documento.
creationDate Obtiene la fecha de creación del documento.
customProperties Obtiene la colección de propiedades personalizadas del documento.
format Especifica el formato del documento.
Palabras clave Especifica las palabras clave del documento.
lastAuthor Obtiene el último autor del documento.
lastPrintDate Obtiene la última fecha de impresión del documento.
lastSaveTime Obtiene la última fecha de modificación del documento.
director Especifica el administrador del documento.
revisionNumber Obtiene el número de revisión del documento.
seguridad Obtiene la configuración de seguridad del documento.
subject Especifica el asunto del documento.
template Obtiene la plantilla del documento.
title Especifica el título del documento.
InlinePicture getNext() Obtiene la siguiente imagen incorporada.
getNextOrNullObject() Obtiene la siguiente imagen incorporada.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | "Entero" | "Iniciar" | "End") Obtiene la imagen, o el punto de inicio o final de la imagen, como un intervalo.
parentContentControlOrNullObject Obtiene el control de contenido que contiene la imagen incorporada.
parentTable Obtiene la tabla que contiene la imagen incorporada.
parentTableCell Obtiene la celda de tabla que contiene la imagen incorporada.
parentTableCellOrNullObject Obtiene la celda de tabla que contiene la imagen incorporada.
parentTableOrNullObject Obtiene la tabla que contiene la imagen incorporada.
InlinePictureCollection getFirst() Obtiene la primera imagen incorporada de esta colección.
getFirstOrNullObject() Obtiene la primera imagen incorporada de esta colección.
Lista getLevelParagraphs(level: number) Obtiene los párrafos que se producen en el nivel especificado de la lista.
getLevelString(level: number) Obtiene la viñeta, el número o la imagen en el nivel especificado como una cadena.
id Obtiene el identificador de la lista.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | Word. InsertLocation.before | Word. InsertLocation.after | "Iniciar" | "End" | "Before" | "Después") Inserta un párrafo en la ubicación especificada.
levelExistences Comprueba si cada uno de los 9 niveles existe en la lista.
levelTypes Obtiene todos los tipos de los 9 niveles de la lista.
paragraphs Obtiene los párrafos de la lista.
setLevelAlignment(level: number, alignment: Word. Alineación) Establece la alineación de la viñeta, el número o la imagen en el nivel especificado de la lista.
setLevelBullet(level: number, listBullet: Word. ListBullet, charCode?: number, fontName?: string) Establece el formato de viñeta en el nivel especificado de la lista.
setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number) Establece las dos sangrías del nivel especificado de la lista.
setLevelNumbering(level: number, listNumbering: Word. ListNumbering, formatString?: Cadena de matriz<| number>) Establece el formato de numeración en el nivel especificado de la lista.
setLevelStartingNumber(level: number, startingNumber: number) Establece el número de inicio en el nivel especificado de la lista.
listCollection getById(id: number) Obtiene una lista mediante su identificador.
getByIdOrNullObject(id: number) Obtiene una lista mediante su identificador.
getFirst() Obtiene la primera lista de esta colección.
getFirstOrNullObject() Obtiene la primera lista de esta colección.
getItem(id: number) Obtiene un objeto de lista por su identificador.
items Obtiene los elementos secundarios cargados en esta colección.
ListItem getAncestor(parentOnly?: boolean) Obtiene el elemento primario del elemento de lista o el antecesor más cercano si el elemento primario no existe.
getAncestorOrNullObject(parentOnly?: boolean) Obtiene el elemento primario del elemento de lista o el antecesor más cercano si el elemento primario no existe.
getDescendants(directChildrenOnly?: boolean) Obtiene todos los elementos de lista descendientes del elemento de lista.
level Especifica el nivel del elemento de la lista.
listString Obtiene la viñeta, el número o la imagen del elemento de lista como una cadena.
siblingIndex Obtiene el número de ordenación del elemento de lista en relación a los de su mismo nivel.
Paragraph attachToList(listId: number, level: number) Permite que el párrafo se una a una lista existente en el nivel especificado.
detachFromList() Mueve este párrafo fuera de la lista, si este es un elemento de lista.
getNext() Obtiene el párrafo siguiente.
getNextOrNullObject() Obtiene el párrafo siguiente.
getPrevious() Obtiene el párrafo anterior.
getPreviousOrNullObject() Obtiene el párrafo anterior.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | "Entero" | "Iniciar" | "End" | "Después" | "Contenido") Obtiene el párrafo completo, o el punto de inicio o final del párrafo, como un intervalo.
getTextRanges(endingMarks: string[], trimSpacing?: boolean) Obtiene los intervalos de texto del párrafo mediante signos de puntuación u otras marcas finales.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", values?: string[][]) Inserta una tabla con el número especificado de filas y columnas.
isLastParagraph Indica el párrafo que es el último dentro de su cuerpo primario.
isListItem Comprueba si el párrafo es un elemento de lista.
list Obtiene la lista a la que pertenece este párrafo.
listItem Obtiene ListItem para el párrafo.
listItemOrNullObject Obtiene ListItem para el párrafo.
listOrNullObject Obtiene la lista a la que pertenece este párrafo.
parentBody Obtiene el cuerpo primario del párrafo.
parentContentControlOrNullObject Obtiene el control de contenido que contiene el párrafo.
parentTable Obtiene la tabla que contiene el párrafo.
parentTableCell Obtiene la celda de tabla que contiene el párrafo.
parentTableCellOrNullObject Obtiene la celda de tabla que contiene el párrafo.
parentTableOrNullObject Obtiene la tabla que contiene el párrafo.
split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean) Divide el párrafo en intervalos secundarios mediante delimitadores.
startNewList() Inicia una nueva lista con este párrafo.
styleBuiltIn Especifica el nombre de estilo integrado para el párrafo.
tableNestingLevel Obtiene el nivel de la tabla del párrafo.
ParagraphCollection getFirst() Obtiene el primer párrafo de esta colección.
getFirstOrNullObject() Obtiene el primer párrafo de esta colección.
getLast() Obtiene el último párrafo de esta colección.
getLastOrNullObject() Obtiene el último párrafo de esta colección.
Rango compareLocationWith(range: Word. Rango) Compara esta ubicación del intervalo con otra ubicación de este.
expandTo(range: Word. Rango) Devuelve un nuevo intervalo que se extiende desde este intervalo en cualquier dirección para cubrir otro intervalo.
expandToOrNullObject(range: Word. Rango) Devuelve un nuevo intervalo que se extiende desde este intervalo en cualquier dirección para cubrir otro intervalo.
getHyperlinkRanges() Obtiene intervalos secundarios de hipervínculo dentro del intervalo.
getNextTextRange(endingMarks: string[], trimSpacing?: boolean) Obtiene el siguiente intervalo de texto mediante signos de puntuación u otras marcas finales.
getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean) Obtiene el siguiente intervalo de texto mediante signos de puntuación u otras marcas finales.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | Word. RangeLocation.content | "Entero" | "Iniciar" | "End" | "Después" | "Contenido") Clona el intervalo u obtiene el punto inicial o final del intervalo como un intervalo nuevo.
getTextRanges(endingMarks: string[], trimSpacing?: boolean) Obtiene los intervalos secundarios de texto del intervalo mediante signos de puntuación u otras marcas finales.
hyperlink Obtiene el primer hipervínculo del intervalo, o establece un hipervínculo en el intervalo.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", values?: string[][]) Inserta una tabla con el número especificado de filas y columnas.
intersectWith(range: Word. Rango) Devuelve un intervalo nuevo como la intersección de este intervalo con otro.
intersectWithOrNullObject(range: Word. Rango) Devuelve un intervalo nuevo como la intersección de este intervalo con otro.
isEmpty Comprueba si la longitud del intervalo es cero.
lists Obtiene la colección de objetos de lista en el intervalo.
parentBody Obtiene el cuerpo primario del intervalo.
parentContentControlOrNullObject Obtiene el control de contenido admitido actualmente que contiene el intervalo.
parentTable Obtiene la tabla que contiene el intervalo.
parentTableCell Obtiene la celda de tabla que contiene el intervalo.
parentTableCellOrNullObject Obtiene la celda de tabla que contiene el intervalo.
parentTableOrNullObject Obtiene la tabla que contiene el intervalo.
split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean) Divide el intervalo en intervalos secundarios mediante delimitadores.
styleBuiltIn Especifica el nombre de estilo integrado para el intervalo.
Mesas Obtiene la colección de objetos de tabla en el intervalo.
RangeCollection getFirst() Obtiene el primer intervalo de esta colección.
getFirstOrNullObject() Obtiene el primer intervalo de esta colección.
RequestContext application [Conjunto de api: WordApi 1.3] *
Section getNext() Obtiene la próxima sección.
getNextOrNullObject() Obtiene la próxima sección.
SectionCollection getFirst() Obtiene la primera sección de esta colección.
getFirstOrNullObject() Obtiene la primera sección de esta colección.
Estilo
Tabla addColumns(insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Iniciar" | "End", columnCount: number, values?: string[][]) Agrega columnas al inicio o al final de la tabla, mediante la primera o la última columna existente como una plantilla.
addRows(insertLocation: Word. InsertLocation.start | Word. InsertLocation.end | "Iniciar" | "End", rowCount: number, values?: string[][]) Agrega filas al inicio o al final de la tabla, mediante la primera o la última fila existente como una plantilla.
alineación Especifica la alineación de la tabla con la columna de página.
autoFitWindow() Ajusta automáticamente las columnas de la tabla al ancho de la ventana.
clear() Borra el contenido de la tabla.
delete() Elimina toda la tabla.
deleteColumns(columnIndex: number, columnCount?: number) Elimina las columnas especificadas.
deleteRows(rowIndex: number, rowCount?: number) Elimina las filas especificadas.
distributeColumns() Distribuye los anchos de columna de manera uniforme.
font Obtiene la fuente.
getBorder(borderLocation: Word. BorderLocation) Obtiene el estilo del borde para el borde especificado.
getCell(rowIndex: number, cellIndex: number) Obtiene la celda de tabla de una fila y columna especificadas.
getCellOrNullObject(rowIndex: number, cellIndex: number) Obtiene la celda de tabla de una fila y columna especificadas.
getCellPadding(cellPaddingLocation: Word. CellPaddingLocation) Obtiene el espaciado entre borde y texto en puntos.
getNext() Obtiene la próxima tabla.
getNextOrNullObject() Obtiene la próxima tabla.
getParagraphAfter() Obtiene el párrafo después de la tabla.
getParagraphAfterOrNullObject() Obtiene el párrafo después de la tabla.
getParagraphBefore() Obtiene el párrafo antes de la tabla.
getParagraphBeforeOrNullObject() Obtiene el párrafo antes de la tabla.
getRange(rangeLocation?: Word. RangeLocation.whole | Word. RangeLocation.start | Word. RangeLocation.end | Word. RangeLocation.after | "Entero" | "Iniciar" | "End" | "Después") Obtiene el intervalo que contiene esta tabla, o el intervalo al inicio o al final de la tabla.
headerRowCount Especifica el número de filas de encabezado.
horizontalAlignment Especifica la alineación horizontal de cada celda de la tabla.
insertContentControl() Inserta un control de contenido en la tabla.
insertParagraph(paragraphText: string, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "Después") Inserta un párrafo en la ubicación especificada.
insertTable(rowCount: number, columnCount: number, insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", values?: string[][]) Inserta una tabla con el número especificado de filas y columnas.
isUniform Indica si todas las filas de la tabla son uniformes.
nestingLevel Obtiene el nivel de anidamiento de la tabla.
parentBody Obtiene el cuerpo primario de la tabla.
parentContentControl Obtiene el control de contenido que contiene la tabla.
parentContentControlOrNullObject Obtiene el control de contenido que contiene la tabla.
parentTable Obtiene la tabla que contiene esta tabla.
parentTableCell Obtiene la celda de tabla que contiene esta tabla.
parentTableCellOrNullObject Obtiene la celda de tabla que contiene esta tabla.
parentTableOrNullObject Obtiene la tabla que contiene esta tabla.
rowCount Obtiene el número de filas de la tabla.
rows Obtiene todas las filas de la tabla.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Realiza una búsqueda con las SearchOptions especificadas en el ámbito del objeto table.
select(selectionMode?: Word. SelectionMode) Selecciona la tabla, o la posición al inicio o al final de la tabla, y dirige ahí la interfaz de usuario de Word.
setCellPadding(cellPaddingLocation: Word. CellPaddingLocation, cellPadding: number) Establece el espaciado entre borde y texto en puntos.
shadingColor Especifica el color de sombreado.
estilo Especifica el nombre de estilo de la tabla.
styleBandedColumns Especifica si la tabla tiene columnas en bandas.
styleBandedRows Especifica si la tabla tiene filas agrupadas.
styleBuiltIn Especifica el nombre de estilo integrado de la tabla.
styleFirstColumn Especifica si la tabla tiene una primera columna con un estilo especial.
styleLastColumn Especifica si la tabla tiene una última columna con un estilo especial.
styleTotalRow Especifica si la tabla tiene una fila total (última) con un estilo especial.
Mesas Obtiene las tablas secundarias anidadas un nivel más profundo.
values Especifica los valores de texto de la tabla, como una matriz de JavaScript 2D.
verticalAlignment Especifica la alineación vertical de cada celda de la tabla.
width Especifica el ancho de la tabla en puntos.
TableBorder color Especifica el color del borde de la tabla.
type Especifica el tipo del borde de la tabla.
width Especifica el ancho, en puntos, del borde de la tabla.
TableCell body Obtiene el objeto de cuerpo de la celda.
cellIndex Obtiene el índice de la celda de la fila.
columnWidth Especifica el ancho de la columna de la celda en puntos.
deleteColumn() Elimina la columna que contiene esta celda.
deleteRow() Elimina la fila que contiene esta celda.
getBorder(borderLocation: Word. BorderLocation) Obtiene el estilo del borde para el borde especificado.
getCellPadding(cellPaddingLocation: Word. CellPaddingLocation) Obtiene el espaciado entre borde y texto en puntos.
getNext() Obtiene la celda siguiente.
getNextOrNullObject() Obtiene la celda siguiente.
horizontalAlignment Especifica la alineación horizontal de la celda.
insertColumns(insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]) Agrega columnas a la izquierda o derecha de la celda, mediante la columna de la celda como una plantilla.
insertRows(insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]) Inserta filas por encima o debajo de la celda, mediante la fila de la celda como una plantilla.
parentRow Obtiene la fila primaria de la celda.
parentTable Obtiene la tabla primaria de la celda.
rowIndex Obtiene el índice de fila de la celda en la tabla.
setCellPadding(cellPaddingLocation: Word. CellPaddingLocation, cellPadding: number) Establece el espaciado entre borde y texto en puntos.
shadingColor Especifica el color de sombreado de la celda.
value Especifica el texto de la celda.
verticalAlignment Especifica la alineación vertical de la celda.
width Obtiene el ancho de la celda en puntos.
TableCellCollection getFirst() Obtiene la primera celda de tabla de esta colección.
getFirstOrNullObject() Obtiene la primera celda de tabla de esta colección.
items Obtiene los elementos secundarios cargados en esta colección.
TableCollection getFirst() Obtiene la primera tabla de esta colección.
getFirstOrNullObject() Obtiene la primera tabla de esta colección.
items Obtiene los elementos secundarios cargados en esta colección.
TableRow cellCount Obtiene el número de celdas de la fila.
células Obtiene celdas.
clear() Borra el contenido de la fila.
delete() Elimina toda la fila.
font Obtiene la fuente.
getBorder(borderLocation: Word. BorderLocation) Obtiene el estilo del borde de las celdas de la fila.
getCellPadding(cellPaddingLocation: Word. CellPaddingLocation) Obtiene el espaciado entre borde y texto en puntos.
getNext() Obtiene la fila siguiente.
getNextOrNullObject() Obtiene la fila siguiente.
horizontalAlignment Especifica la alineación horizontal de cada celda de la fila.
insertRows(insertLocation: Word. InsertLocation.before | Word. InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]) Inserta filas mediante esta fila como una plantilla.
isHeader Comprueba si la fila es una fila de encabezado.
parentTable Obtiene la tabla primaria.
preferredHeight Especifica el alto preferido de la fila en puntos.
rowIndex Obtiene el índice de la fila en la tabla primaria.
search(searchText: string, searchOptions?: Word. SearchOptions | { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean }) Realiza una búsqueda con las SearchOptions especificadas en el ámbito de la fila.
select(selectionMode?: Word. SelectionMode) Selecciona la fila y se desplaza por la interfaz de usuario de Word hasta ella.
setCellPadding(cellPaddingLocation: Word. CellPaddingLocation, cellPadding: number) Establece el espaciado entre borde y texto en puntos.
shadingColor Especifica el color de sombreado.
values Especifica los valores de texto de la fila, como una matriz de JavaScript 2D.
verticalAlignment Especifica la alineación vertical de las celdas de la fila.
TableRowCollection getFirst() Obtiene la primera fila de esta colección.
getFirstOrNullObject() Obtiene la primera fila de esta colección.
items Obtiene los elementos secundarios cargados en esta colección.

Vea también