Word.Table class

Referencia

Paquete:: word

Representa una tabla de un documento Word.

Extends: OfficeExtension.ClientObject

Comentarios

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/table-cell-access.yaml

await Word.run(async (context) => {
  // Use a two-dimensional array to hold the initial table values.
  const data = [
    ["Tokyo", "Beijing", "Seattle"],
    ["Apple", "Orange", "Pineapple"]
  ];
  const table = context.document.body.insertTable(2, 3, "Start", data);
  table.styleBuiltIn = Word.BuiltInStyleName.gridTable5Dark_Accent2;
  table.styleFirstColumn = false;

  await context.sync();
});

Propiedades

alignment	Especifica la alineación de la tabla con la columna de página. El valor puede ser "Left", "Centered" o "Right".
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
endnotes	Obtiene la colección de notas al final de la tabla.
fields	Obtiene la colección de objetos de campo de la tabla.
font	Obtiene la fuente. Úselo para obtener y establecer el nombre de la fuente, el tamaño, el color y otras propiedades.
footnotes	Obtiene la colección de notas al pie de la tabla.
headerRowCount	Especifica el número de filas de encabezado.
horizontalAlignment	Especifica la alineación horizontal de cada celda de la tabla. El valor puede ser "Left", "Centered", "Right" o "Justified".
isUniform	Indica si todas las filas de la tabla son uniformes.
nestingLevel	Obtiene el nivel de anidamiento de la tabla. Las tablas de nivel superior tienen el nivel 1.
parentBody	Obtiene el cuerpo primario de la tabla.
parentContentControl	Obtiene el control de contenido que contiene la tabla. Produce un `ItemNotFound` error si no hay un control de contenido primario.
parentContentControlOrNullObject	Obtiene el control de contenido que contiene la tabla. Si no hay un control de contenido primario, 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).
parentTable	Obtiene la tabla que contiene esta tabla. Produce un `ItemNotFound` error si no está incluido en una tabla.
parentTableCell	Obtiene la celda de tabla que contiene esta tabla. Produce un `ItemNotFound` error si no está contenido en una celda de tabla.
parentTableCellOrNullObject	Obtiene la celda de tabla que contiene esta tabla. Si no está contenido en una celda de tabla, 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).
parentTableOrNullObject	Obtiene la tabla que contiene esta tabla. Si no está contenido en una tabla, 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).
rowCount	Obtiene el número de filas de la tabla.
rows	Obtiene todas las filas de la tabla.
shadingColor	Especifica el color de sombreado. El color se especifica en el formato "#RRGGBB" o mediante el nombre del color.
style	Especifica el nombre de estilo de la tabla. Use esta propiedad para los estilos personalizados y los nombres de estilo localizados. Para usar los estilos integrados portátiles entre configuraciones regionales, consulte la propiedad "styleBuiltIn".
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. Use esta propiedad para los estilos integrados que son portátiles entre configuraciones regionales. Para usar estilos personalizados o nombres de estilo localizados, consulte la propiedad "style".
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.
tables	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. El valor puede ser "Top", "Center" o "Bottom".
width	Especifica el ancho de la tabla en puntos.

Métodos

addColumns(insertLocation, columnCount, values)	Agrega columnas al inicio o al final de la tabla, mediante la primera o la última columna existente 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.
addRows(insertLocation, rowCount, values)	Agrega filas al inicio o al final de la tabla, mediante la primera o la última fila existente como una plantilla. Los valores de cadena, si se especifican, se establecen en las filas recién insertadas.
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, columnCount)	Elimina las columnas especificadas. Esto se aplica a las tablas uniformes.
deleteRows(rowIndex, rowCount)	Elimina las filas especificadas.
distributeColumns()	Distribuye los anchos de columna de manera uniforme. Esto se aplica a las tablas uniformes.
getBorder(borderLocation)	Obtiene el estilo del borde para el borde especificado.
getBorder(borderLocationString)	Obtiene el estilo del borde para el borde especificado.
getCell(rowIndex, cellIndex)	Obtiene la celda de tabla de una fila y columna especificadas. Produce un `ItemNotFound` error si la celda de tabla especificada no existe.
getCellOrNullObject(rowIndex, cellIndex)	Obtiene la celda de tabla de una fila y columna especificadas. Si la celda de tabla especificada no existe, 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).
getCellPadding(cellPaddingLocation)	Obtiene el espaciado entre borde y texto en puntos.
getCellPadding(cellPaddingLocationString)	Obtiene el espaciado entre borde y texto en puntos.
getNext()	Obtiene la próxima tabla. Produce un `ItemNotFound` error si esta tabla es la última.
getNextOrNullObject()	Obtiene la próxima tabla. Si esta tabla 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).
getParagraphAfter()	Obtiene el párrafo después de la tabla. Produce un `ItemNotFound` error si no hay un párrafo después de la tabla.
getParagraphAfterOrNullObject()	Obtiene el párrafo después de la tabla. Si no hay un párrafo después de la tabla, 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).
getParagraphBefore()	Obtiene el párrafo antes de la tabla. Produce un `ItemNotFound` error si no hay un párrafo antes de la tabla.
getParagraphBeforeOrNullObject()	Obtiene el párrafo antes de la tabla. Si no hay un párrafo antes de la tabla, 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).
getRange(rangeLocation)	Obtiene el intervalo que contiene esta tabla, o el intervalo al inicio o al final de la tabla.
insertContentControl()	Inserta un control de contenido en la tabla.
insertParagraph(paragraphText, insertLocation)	Inserta un párrafo en la ubicación especificada.
insertTable(rowCount, columnCount, insertLocation, values)	Inserta una tabla con el número especificado de filas y columnas.
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(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a `context.sync()` antes de leer las propiedades.
mergeCells(topRow, firstCell, bottomRow, lastCell)	Combina las celdas delimitadas de forma inclusiva por una primera y última celda.
search(searchText, searchOptions)	Realiza una búsqueda con las SearchOptions especificadas en el ámbito del objeto table. Los resultados de la búsqueda son una colección de objetos de intervalo.
select(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.
select(selectionModeString)	Selecciona la tabla, o la posición al inicio o al final de la tabla, y dirige ahí la interfaz de usuario de Word.
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.
setCellPadding(cellPaddingLocation, cellPadding)	Establece el espaciado entre borde y texto en puntos.
setCellPadding(cellPaddingLocationString, cellPadding)	Establece el espaciado entre borde y texto en puntos.
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 Word original. El objeto Table es un objeto de API, el `toJSON` método devuelve un objeto JavaScript sin formato (escrito como `Word.Interfaces.TableData`) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
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.
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.

Detalles de las propiedades

alignment

Especifica la alineación de la tabla con la columna de página. El valor puede ser "Left", "Centered" o "Right".

alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Valor de propiedad

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 alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`);
  console.log(`- Alignment of the table within the containing page column: ${firstTable.alignment}`);
  console.log(`- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

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

Word.RequestContext

endnotes

Obtiene la colección de notas al final de la tabla.

readonly endnotes: Word.NoteItemCollection;

Valor de propiedad

Word.NoteItemCollection

Comentarios

[ Conjunto de API: WordApi 1.5 ]

fields

Obtiene la colección de objetos de campo de la tabla.

readonly fields: Word.FieldCollection;

Valor de propiedad

Word.FieldCollection

Comentarios

[ Conjunto de API: WordApi 1.4 ]

font

Obtiene la fuente. Úselo para obtener y establecer el nombre de la fuente, el tamaño, el color y otras propiedades.

readonly font: Word.Font;

Valor de propiedad

Word.Font

Comentarios

[ Conjunto de API: WordApi 1.3 ]

footnotes

Obtiene la colección de notas al pie de la tabla.

readonly footnotes: Word.NoteItemCollection;

Valor de propiedad

Word.NoteItemCollection

Comentarios

[ Conjunto de API: WordApi 1.5 ]

headerRowCount

Especifica el número de filas de encabezado.

headerRowCount: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.3 ]

horizontalAlignment

Especifica la alineación horizontal de cada celda de la tabla. El valor puede ser "Left", "Centered", "Right" o "Justified".

horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Valor de propiedad

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 alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`);
  console.log(`- Alignment of the table within the containing page column: ${firstTable.alignment}`);
  console.log(`- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

isUniform

Indica si todas las filas de la tabla son uniformes.

readonly isUniform: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.3 ]

nestingLevel

Obtiene el nivel de anidamiento de la tabla. Las tablas de nivel superior tienen el nivel 1.

readonly nestingLevel: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentBody

Obtiene el cuerpo primario de la tabla.

readonly parentBody: Word.Body;

Valor de propiedad

Word.Body

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentContentControl

Obtiene el control de contenido que contiene la tabla. Produce un ItemNotFound error si no hay un control de contenido primario.

readonly parentContentControl: Word.ContentControl;

Valor de propiedad

Word.ContentControl

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentContentControlOrNullObject

Obtiene el control de contenido que contiene la tabla. Si no hay un control de contenido primario, 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).

readonly parentContentControlOrNullObject: Word.ContentControl;

Valor de propiedad

Word.ContentControl

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentTable

Obtiene la tabla que contiene esta tabla. Produce un ItemNotFound error si no está incluido en una tabla.

readonly parentTable: Word.Table;

Valor de propiedad

Word.Table

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentTableCell

Obtiene la celda de tabla que contiene esta tabla. Produce un ItemNotFound error si no está contenido en una celda de tabla.

readonly parentTableCell: Word.TableCell;

Valor de propiedad

Word.TableCell

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentTableCellOrNullObject

Obtiene la celda de tabla que contiene esta tabla. Si no está contenido en una celda de tabla, 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).

readonly parentTableCellOrNullObject: Word.TableCell;

Valor de propiedad

Word.TableCell

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentTableOrNullObject

Obtiene la tabla que contiene esta tabla. Si no está contenido en una tabla, 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).

readonly parentTableOrNullObject: Word.Table;

Valor de propiedad

Word.Table

Comentarios

[ Conjunto de API: WordApi 1.3 ]

rowCount

Obtiene el número de filas de la tabla.

readonly rowCount: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.3 ]

rows

Obtiene todas las filas de la tabla.

readonly rows: Word.TableRowCollection;

Valor de propiedad

Word.TableRowCollection

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 row of the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const firstTableRow = firstTable.rows.getFirst();
  firstTableRow.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table's first row:`);
  console.log(`- Horizontal alignment of every cell in the row: ${firstTableRow.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the row: ${firstTableRow.verticalAlignment}`);
});

shadingColor

Especifica el color de sombreado. El color se especifica en el formato "#RRGGBB" o mediante el nombre del color.

shadingColor: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

style

Especifica el nombre de estilo de la tabla. Use esta propiedad para los estilos personalizados y los nombres de estilo localizados. Para usar los estilos integrados portátiles entre configuraciones regionales, consulte la propiedad "styleBuiltIn".

style: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: WordApi 1.3 ]

styleBandedColumns

Especifica si la tabla tiene columnas en bandas.

styleBandedColumns: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.3 ]

styleBandedRows

Especifica si la tabla tiene filas agrupadas.

styleBandedRows: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.3 ]

styleBuiltIn

Especifica el nombre de estilo integrado de la tabla. Use esta propiedad para los estilos integrados que son portátiles entre configuraciones regionales. Para usar estilos personalizados o nombres de estilo localizados, consulte la propiedad "style".

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.3 ]

styleFirstColumn

Especifica si la tabla tiene una primera columna con un estilo especial.

styleFirstColumn: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.3 ]

styleLastColumn

Especifica si la tabla tiene una última columna con un estilo especial.

styleLastColumn: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.3 ]

styleTotalRow

Especifica si la tabla tiene una fila total (última) con un estilo especial.

styleTotalRow: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.3 ]

tables

Obtiene las tablas secundarias anidadas un nivel más profundo.

readonly tables: Word.TableCollection;

Valor de propiedad

Word.TableCollection

Comentarios

[ Conjunto de API: WordApi 1.3 ]

values

Especifica los valores de texto de la tabla, como una matriz de JavaScript 2D.

values: string[][];

Valor de propiedad

string[][]

Comentarios

[ Conjunto de API: WordApi 1.3 ]

verticalAlignment

Especifica la alineación vertical de cada celda de la tabla. 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 alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`);
  console.log(`- Alignment of the table within the containing page column: ${firstTable.alignment}`);
  console.log(`- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

width

Especifica el ancho de la tabla en puntos.

width: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Detalles del método

addColumns(insertLocation, columnCount, values)

Agrega columnas al inicio o al final de la tabla, mediante la primera o la última columna existente 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.

addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void;

Parámetros

insertLocation: start | end | "Start" | "End"

Obligatorio. Debe ser "Start" o "End", correspondiente al lado adecuado de la tabla.

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

[ Conjunto de API: WordApi 1.3 ]

addRows(insertLocation, rowCount, values)

Agrega filas al inicio o al final de la tabla, mediante la primera o la última fila existente como una plantilla. Los valores de cadena, si se especifican, se establecen en las filas recién insertadas.

addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection;

Parámetros

insertLocation: start | end | "Start" | "End"

Obligatorio. Debe ser "Start" o "End".

rowCount: number

Obligatorio. Número de filas que se van a agregar.

values: string[][]

deleteColumns(columnIndex: number, columnCount?: number): void;

Parámetros

columnIndex: number

Obligatorio. Primera columna que se va a eliminar.

columnCount: number

Opcional. Número de columnas que se van a eliminar. Valor predeterminado 1.

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

deleteRows(rowIndex, rowCount)

Elimina las filas especificadas.

deleteRows(rowIndex: number, rowCount?: number): void;

Parámetros

rowIndex: number

Obligatorio. Primera fila que se va a eliminar.

rowCount: number

Opcional. Número de filas que se van a eliminar. Valor predeterminado 1.

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

distributeColumns()

Distribuye los anchos de columna de manera uniforme. Esto se aplica a las tablas uniformes.

distributeColumns(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Word.TableBorder

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 table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const borderLocation = Word.BorderLocation.top;
  const border = firstTable.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

  console.log(`Details about the ${borderLocation} border of the first table:`);
  console.log(`- Color: ${border.color}`);
  console.log(`- Type: ${border.type}`);
  console.log(`- Width: ${border.width} points`);
});

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

Word.TableBorder

Comentarios

[ Conjunto de API: WordApi 1.3 ]

getCell(rowIndex, cellIndex)

Obtiene la celda de tabla de una fila y columna especificadas. Produce un ItemNotFound error si la celda de tabla especificada no existe.

getCell(rowIndex: number, cellIndex: number): Word.TableCell;

Parámetros

rowIndex: number

Obligatorio. Índice de la fila.

cellIndex: number

Obligatorio. Índice de la celda de la fila.

Devoluciones

Word.TableCell

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/table-cell-access.yaml

// Gets the content of the first cell in the first table.
await Word.run(async (context) => {
  const firstCell = context.document.body.tables.getFirst().getCell(0, 0).body;
  firstCell.load("text");

  await context.sync();
  console.log("First cell's text is: " + firstCell.text);
});

getCellOrNullObject(rowIndex, cellIndex)

Obtiene la celda de tabla de una fila y columna especificadas. Si la celda de tabla especificada no existe, 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).

getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell;

Parámetros

rowIndex: number

Obligatorio. Índice de la fila.

cellIndex: number

Obligatorio. Índice de la celda de la fila.

Devoluciones

Word.TableCell

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

[ 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 table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const cellPaddingLocation = Word.CellPaddingLocation.right;
  const cellPadding = firstTable.getCellPadding(cellPaddingLocation);
  await context.sync();

  console.log(
    `Cell padding details about the ${cellPaddingLocation} border of the first table: ${cellPadding.value} points`
  );
});

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"

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range;

Parámetros

rangeLocation: whole | start | end | after | "Whole" | "Start" | "End" | "After"

Opcional. La ubicación del intervalo debe ser "Whole", "Start", "End" o "After".

Devoluciones

Word.Range

Comentarios

[ Conjunto de API: WordApi 1.3 ]

insertContentControl()

Inserta un control de contenido en la tabla.

insertContentControl(): Word.ContentControl;

Devoluciones

Word.ContentControl

Comentarios

[ Conjunto de API: WordApi 1.3 ]

insertParagraph(paragraphText, insertLocation)

Inserta un párrafo en la ubicación especificada.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

Parámetros

paragraphText: string

Obligatorio. Texto de párrafo que se va a insertar.

insertLocation: before | after | "Before" | "After"

Obligatorio. El valor debe ser "Before" o "After".

Devoluciones

Word.Paragraph

Comentarios

[ Conjunto de API: WordApi 1.3 ]

insertTable(rowCount, columnCount, insertLocation, values)

Inserta una tabla con el número especificado de filas y columnas.

insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", values?: string[][]): Word.Table;

Parámetros

rowCount: number

Obligatorio. Número de filas de la tabla.

columnCount: number

Obligatorio. Número de columnas de la tabla.

insertLocation: before | after | "Before" | "After"

Obligatorio. El valor debe ser "Before" o "After".

values: string[][]

Matriz 2D opcional. Si se especifican las cadenas correspondientes en la matriz, se rellenan las celdas.

Devoluciones

Word.Table

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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.TableLoadOptions): Word.Table;

Parámetros

options: Word.Interfaces.TableLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Word.Table

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.Table;

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

Word.Table

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.Table;

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

Word.Table

mergeCells(topRow, firstCell, bottomRow, lastCell)

Combina las celdas delimitadas de forma inclusiva por una primera y última celda.

mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell;

Parámetros

topRow: number

Obligatorio. Fila de la primera celda

firstCell: number

Obligatorio. Índice de la primera celda de su fila

bottomRow: number

Obligatorio. Fila de la última celda

lastCell: number

Obligatorio. Índice de la última celda de su fila

Devoluciones

Word.TableCell

Comentarios

[ Conjunto de API: WordApi 1.4 ]

search(searchText, searchOptions)

Realiza una búsqueda con las SearchOptions especificadas en el ámbito del objeto table. Los resultados de la búsqueda son una colección de objetos de intervalo.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Parámetros

searchText: string

Obligatorio. Texto de búsqueda.

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Opcional. Opciones de la búsqueda.

Devoluciones

Word.RangeCollection

Comentarios

[ Conjunto de API: WordApi 1.3 ]

select(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.

select(selectionMode?: Word.SelectionMode): void;

Parámetros

selectionMode: Word.SelectionMode

Opcional. El modo de selección debe ser "Seleccionar", "Iniciar" o "Finalizar". 'Select' es el valor predeterminado.

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

select(selectionModeString)

Selecciona la tabla, o la posición al inicio o al final de la tabla, y dirige ahí la interfaz de usuario de Word.

select(selectionModeString?: "Select" | "Start" | "End"): void;

Parámetros

selectionModeString: "Select" | "Start" | "End"

Opcional. El modo de selección debe ser "Seleccionar", "Iniciar" o "Finalizar". 'Select' es el valor predeterminado.

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties: Word.Interfaces.TableUpdateData

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.Table): void;

Parámetros

properties: Word.Table

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

[ Conjunto de API: WordApi 1.3 ]

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

[ Conjunto de API: WordApi 1.3 ]

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.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el Word original. El objeto Table es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.TableData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.TableData;

Devoluciones

Word.Interfaces.TableData

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.Table;

Devoluciones

Word.Table

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.Table;

Devoluciones

Word.Table