Word.TableCell class
Representa una celda de tabla en un documento Word.
- Extends
Comentarios
[ Conjunto de API: WordApi 1.3 ]
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
body | Obtiene el objeto de cuerpo de la celda. |
cell |
Obtiene el índice de la celda de la fila. |
column |
Especifica el ancho de la columna de la celda en puntos. Esto se aplica a las tablas uniformes. |
context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
horizontal |
Especifica la alineación horizontal de la celda. El valor puede ser "Left", "Centered", "Right" o "Justified". |
parent |
Obtiene la fila primaria de la celda. |
parent |
Obtiene la tabla primaria de la celda. |
row |
Obtiene el índice de fila de la celda en la tabla. |
shading |
Especifica el color de sombreado de la celda. El color se especifica en el formato "#RRGGBB" o mediante el nombre del color. |
value | Especifica el texto de la celda. |
vertical |
Especifica la alineación vertical de la celda. El valor puede ser "Top", "Center" o "Bottom". |
width | Obtiene el ancho de la celda en puntos. |
Métodos
delete |
Elimina la columna que contiene esta celda. Esto se aplica a las tablas uniformes. |
delete |
Elimina la fila que contiene esta celda. |
get |
Obtiene el estilo del borde para el borde especificado. |
get |
Obtiene el estilo del borde para el borde especificado. |
get |
Obtiene el espaciado entre borde y texto en puntos. |
get |
Obtiene el espaciado entre borde y texto en puntos. |
get |
Obtiene la celda siguiente. Produce un |
get |
Obtiene la celda siguiente. Si esta celda es la última, este método devolverá un objeto con su |
insert |
Agrega columnas a la izquierda o derecha de la celda, mediante la columna de la celda como una plantilla. Esto se aplica a las tablas uniformes. Los valores de cadena, si se especifican, se establecen en las filas recién insertadas. |
insert |
Inserta filas por encima o debajo de la celda, mediante la fila de la celda como una plantilla. Los valores de cadena, si se especifican, se establecen en las filas recién insertadas. |
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 |
set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo. |
set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
set |
Establece el espaciado entre borde y texto en puntos. |
set |
Establece el espaciado entre borde y texto en puntos. |
split(row |
Divide la celda en el número especificado de filas y columnas. |
toJSON() | Invalida 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 para 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 abreviada para 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. Tendrá que llamar |
Detalles de las propiedades
body
Obtiene el objeto de cuerpo de la celda.
readonly body: Word.Body;
Valor de propiedad
Comentarios
cellIndex
Obtiene el índice de la celda de la fila.
readonly cellIndex: number;
Valor de propiedad
number
Comentarios
columnWidth
Especifica el ancho de la columna de la celda en puntos. Esto se aplica a las tablas uniformes.
columnWidth: number;
Valor de propiedad
number
Comentarios
context
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;
Valor de propiedad
horizontalAlignment
Especifica la alineación horizontal de la celda. El valor puede ser "Left", "Centered", "Right" o "Justified".
horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";
Valor de propiedad
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Comentarios
[ Conjunto de API: WordApi 1.3 ]
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}`);
});
parentRow
Obtiene la fila primaria de la celda.
readonly parentRow: Word.TableRow;
Valor de propiedad
Comentarios
parentTable
Obtiene la tabla primaria de la celda.
readonly parentTable: Word.Table;
Valor de propiedad
Comentarios
rowIndex
Obtiene el índice de fila de la celda en la tabla.
readonly rowIndex: number;
Valor de propiedad
number
Comentarios
shadingColor
Especifica el color de sombreado de la celda. El color se especifica en el formato "#RRGGBB" o mediante el nombre del color.
shadingColor: string;
Valor de propiedad
string
Comentarios
value
Especifica el texto de la celda.
value: string;
Valor de propiedad
string
Comentarios
verticalAlignment
Especifica la alineación vertical de la celda. El valor puede ser "Top", "Center" o "Bottom".
verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";
Valor de propiedad
Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"
Comentarios
[ Conjunto de API: WordApi 1.3 ]
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}`);
});
width
Obtiene el ancho de la celda en puntos.
readonly width: number;
Valor de propiedad
number
Comentarios
Detalles del método
deleteColumn()
Elimina la columna que contiene esta celda. Esto se aplica a las tablas uniformes.
deleteColumn(): void;
Devoluciones
void
Comentarios
deleteRow()
Elimina la fila que contiene esta celda.
deleteRow(): void;
Devoluciones
void
Comentarios
getBorder(borderLocation)
Obtiene el estilo del borde para el borde especificado.
getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;
Parámetros
- borderLocation
- Word.BorderLocation
Obligatorio. Ubicación del borde.
Devoluciones
Comentarios
getBorder(borderLocationString)
Obtiene el estilo del borde para el borde especificado.
getBorder(borderLocationString: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;
Parámetros
- borderLocationString
-
"Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"
Obligatorio. Ubicación del borde.
Devoluciones
Comentarios
[ Conjunto de API: WordApi 1.3 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml
// Gets border details about the first of the first table in the document.
await Word.run(async (context) => {
const firstTable: Word.Table = context.document.body.tables.getFirst();
const firstCell: Word.TableCell = firstTable.getCell(0, 0);
const borderLocation = "Left";
const border: Word.TableBorder = firstCell.getBorder(borderLocation);
border.load(["type", "color", "width"]);
await context.sync();
console.log(`Details about the ${borderLocation} border of the first table's first cell:`, `- Color: ${border.color}`, `- Type: ${border.type}`, `- Width: ${border.width} points`);
});
getCellPadding(cellPaddingLocation)
Obtiene el espaciado entre borde y texto en puntos.
getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;
Parámetros
- cellPaddingLocation
- Word.CellPaddingLocation
Obligatorio. La ubicación del relleno de celda debe ser "Top", "Left", "Bottom" o "Right".
Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
getCellPadding(cellPaddingLocationString)
Obtiene el espaciado entre borde y texto en puntos.
getCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;
Parámetros
- cellPaddingLocationString
-
"Top" | "Left" | "Bottom" | "Right"
Obligatorio. La ubicación del relleno de celda debe ser "Top", "Left", "Bottom" o "Right".
Devoluciones
OfficeExtension.ClientResult<number>
Comentarios
[ Conjunto de API: WordApi 1.3 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml
// Gets cell padding 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 firstCell: Word.TableCell = firstTable.getCell(0, 0);
const cellPaddingLocation = "Left";
const cellPadding = firstCell.getCellPadding(cellPaddingLocation);
await context.sync();
console.log(
`Cell padding details about the ${cellPaddingLocation} border of the first table's first cell: ${cellPadding.value} points`
);
});
getNext()
Obtiene la celda siguiente. Produce un ItemNotFound
error si esta celda es la última.
getNext(): Word.TableCell;
Devoluciones
Comentarios
getNextOrNullObject()
Obtiene la celda siguiente. Si esta celda es la última, este método devolverá un objeto con su isNullObject
propiedad establecida en true
. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
getNextOrNullObject(): Word.TableCell;
Devoluciones
Comentarios
insertColumns(insertLocation, columnCount, values)
Agrega columnas a la izquierda o derecha de la celda, mediante la columna de la celda como una plantilla. Esto se aplica a las tablas uniformes. Los valores de cadena, si se especifican, se establecen en las filas recién insertadas.
insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void;
Parámetros
- columnCount
-
number
Obligatorio. Número de columnas que se van a agregar.
- values
-
string[][]
Matriz 2D opcional. Si se especifican las cadenas correspondientes en la matriz, se rellenan las celdas.
Devoluciones
void
Comentarios
insertRows(insertLocation, rowCount, values)
Inserta filas por encima o debajo de la celda, mediante la fila de la celda como una plantilla. Los valores de cadena, si se especifican, se establecen en las filas recién insertadas.
insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;
Parámetros
- rowCount
-
number
Obligatorio. Número de filas que se van a agregar.
- values
-
string[][]
Matriz 2D opcional. Si se especifican las cadenas correspondientes en la matriz, se rellenan las celdas.
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.TableCellLoadOptions): Word.TableCell;
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.TableCell;
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?: {
select?: string;
expand?: string;
}): Word.TableCell;
Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
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
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.
set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parámetros
- properties
- Word.Interfaces.TableCellUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
set(properties: Word.TableCell): void;
Parámetros
- properties
- Word.TableCell
Devoluciones
void
setCellPadding(cellPaddingLocation, cellPadding)
Establece el espaciado entre borde y texto en puntos.
setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;
Parámetros
- cellPaddingLocation
- Word.CellPaddingLocation
Obligatorio. La ubicación del relleno de celda debe ser "Top", "Left", "Bottom" o "Right".
- cellPadding
-
number
Obligatorio. Relleno de celda.
Devoluciones
void
Comentarios
setCellPadding(cellPaddingLocationString, cellPadding)
Establece el espaciado entre borde y texto en puntos.
setCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;
Parámetros
- cellPaddingLocationString
-
"Top" | "Left" | "Bottom" | "Right"
Obligatorio. La ubicación del relleno de celda debe ser "Top", "Left", "Bottom" o "Right".
- cellPadding
-
number
Obligatorio. Relleno de celda.
Devoluciones
void
Comentarios
split(rowCount, columnCount)
Divide la celda en el número especificado de filas y columnas.
split(rowCount: number, columnCount: number): void;
Parámetros
- rowCount
-
number
Obligatorio. Número de filas en las que se va a dividir. Debe ser un divisor del número de filas subyacentes.
- columnCount
-
number
Obligatorio. Número de columnas en las que se va a dividir.
Devoluciones
void
Comentarios
toJSON()
Invalida el método JavaScript toJSON()
para proporcionar una salida más útil cuando se pasa un objeto de 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.TableCell
es un objeto de API, el toJSON
método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.TableCellData
) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Word.Interfaces.TableCellData;
Devoluciones
track()
Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync
llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene 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 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.TableCell;
Devoluciones
untrack()
Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para 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. Tendrá que llamar context.sync()
a antes de que la versión de memoria surta efecto.
untrack(): Word.TableCell;