Word.TableCellCollection class
Contiene la colección del Word del documento. TableCell objetos.
- Extends
Comentarios
Usada por
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml
// Gets content alignment details about the first cell of the first table in the document.
await Word.run(async (context) => {
const firstTable: Word.Table = context.document.body.tables.getFirst();
const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(
`Details about the alignment of the first table's first cell:`,
`- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`,
`- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`,
);
});
Propiedades
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| items | Obtiene los elementos secundarios cargados en esta colección. |
Métodos
| auto |
Cambia el ancho de la columna de una tabla de modo que se ajuste al ancho del texto sin cambiar la manera en que el texto se ajusta en las celdas. |
| delete(shift |
Elimina las celdas de la tabla y, de manera opcional, controla cómo se desplazan las celdas restantes. |
| delete(shift |
Elimina las celdas de la tabla y, de manera opcional, controla cómo se desplazan las celdas restantes. |
| distribute |
Ajusta el alto de las celdas especificadas para que sean iguales. |
| distribute |
Ajusta el ancho de las celdas especificadas para que sean iguales. |
| get |
Obtiene la primera celda de tabla de esta colección. Produce un |
| get |
Obtiene la primera celda de tabla de esta colección. Si esta colección está vacía, este método devolverá un objeto con su |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| merge() | Combina las celdas especificadas en una sola. |
| set |
Establece la altura de las celdas de una tabla. |
| set |
Establece la altura de las celdas de una tabla. |
| set |
Establece el ancho de las celdas de una tabla. |
| set |
Establece el ancho de las celdas de una tabla. |
| split(options) | Divide este rango de celdas de tabla. |
| toJSON() | Reemplaza el método JavaScript |
| track() | Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre |
| untrack() | Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar |
Detalles de las propiedades
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
items
Obtiene los elementos secundarios cargados en esta colección.
readonly items: Word.TableCell[];Valor de propiedad
Detalles del método
autoFit()
Cambia el ancho de la columna de una tabla de modo que se ajuste al ancho del texto sin cambiar la manera en que el texto se ajusta en las celdas.
autoFit(): void;Devoluciones
void
Comentarios
delete(shiftCells)
Elimina las celdas de la tabla y, de manera opcional, controla cómo se desplazan las celdas restantes.
delete(shiftCells?: Word.DeleteCells): void;Parámetros
- shiftCells
- Word.DeleteCells
Opcional. Especifica cómo se desplazan las celdas restantes después de la eliminación. El valor predeterminado es shiftLeft.
Devoluciones
void
Comentarios
delete(shiftCells)
Elimina las celdas de la tabla y, de manera opcional, controla cómo se desplazan las celdas restantes.
delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void;Parámetros
- shiftCells
-
"ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"
Opcional. Especifica cómo se desplazan las celdas restantes después de la eliminación. El valor predeterminado es shiftLeft.
Devoluciones
void
Comentarios
distributeHeight()
Ajusta el alto de las celdas especificadas para que sean iguales.
distributeHeight(): void;Devoluciones
void
Comentarios
distributeWidth()
Ajusta el ancho de las celdas especificadas para que sean iguales.
distributeWidth(): void;Devoluciones
void
Comentarios
getFirst()
Obtiene la primera celda de tabla de esta colección. Produce un ItemNotFound error si esta colección está vacía.
getFirst(): Word.TableCell;Devoluciones
Comentarios
getFirstOrNullObject()
Obtiene la primera celda de tabla de esta colección. Si esta colección está vacía, este método devolverá un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.
getFirstOrNullObject(): Word.TableCell;Devoluciones
Comentarios
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Word.TableCellCollection;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection;Parámetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
merge()
Combina las celdas especificadas en una sola.
merge(): void;Devoluciones
void
Comentarios
setHeight(rowHeight, heightRule)
Establece la altura de las celdas de una tabla.
setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;Parámetros
- rowHeight
-
number
El alto de la fila que se va a establecer, en puntos.
- heightRule
- Word.RowHeightRule
Norma que determinará el alto de las filas especificadas.
Devoluciones
void
Comentarios
setHeight(rowHeight, heightRule)
Establece la altura de las celdas de una tabla.
setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void;Parámetros
- rowHeight
-
number
El alto de la fila que se va a establecer, en puntos.
- heightRule
-
"Auto" | "AtLeast" | "Exactly"
Norma que determinará el alto de las filas especificadas.
Devoluciones
void
Comentarios
setWidth(columnWidth, rulerStyle)
Establece el ancho de las celdas de una tabla.
setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;Parámetros
- columnWidth
-
number
El ancho de la fila que se va a establecer, en puntos.
- rulerStyle
- Word.RulerStyle
Estilo de regla a aplicar.
Devoluciones
void
Comentarios
setWidth(columnWidth, rulerStyle)
Establece el ancho de las celdas de una tabla.
setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;Parámetros
- columnWidth
-
number
El ancho de la fila que se va a establecer, en puntos.
- rulerStyle
-
"None" | "Proportional" | "FirstColumn" | "SameWidth"
Estilo de regla a aplicar.
Devoluciones
void
Comentarios
split(options)
Divide este rango de celdas de tabla.
split(options?: Word.TableCellCollectionSplitOptions): void;Parámetros
Opcional. Opciones para dividir las celdas de la tabla.
Devoluciones
void
Comentarios
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.TableCellCollection es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.TableCellCollectionData) que contiene una matriz "items" con copias superficiales de cualquier propiedad cargada de los elementos de la colección.
toJSON(): Word.Interfaces.TableCellCollectionData;Devoluciones
track()
Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos objeto de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.
track(): Word.TableCellCollection;Devoluciones
untrack()
Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.
untrack(): Word.TableCellCollection;