Compartir a través de

Word.TableRow class

  • Referencia
Paquete:
word

Representa una fila de un documento Word.

Extends
OfficeExtension.ClientObject

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

cellCount

Obtiene el número de celdas de la fila.
cells

Obtiene celdas.
context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
fields

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

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

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

Comprueba si la fila es una fila de encabezado. Para establecer el número de filas de encabezado, use headerRowCount en el objeto Table.
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.
shadingColor

Especifica el color de sombreado. El color se especifica en el formato "#RRGGBB" o mediante el nombre del color.
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. El valor puede ser "Top", "Center" o "Bottom".

Métodos

clear()

Borra el contenido de la fila.
delete()

Elimina toda la fila.
getBorder(borderLocation)

Obtiene el estilo del borde de las celdas de la fila.
getBorder(borderLocationString)

Obtiene el estilo del borde de las celdas de la fila.
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 fila siguiente. Produce un ItemNotFound error si esta fila es la última.
getNextOrNullObject()

Obtiene la fila siguiente. Si esta fila 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).
insertRows(insertLocation, rowCount, values)

Inserta filas mediante esta fila como una plantilla. Si los valores se especifican, inserta los valores en las nuevas filas.
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.
merge()

Combina la fila en una celda.
search(searchText, searchOptions)

Realiza una búsqueda con las SearchOptions especificadas en el ámbito de la fila. Los resultados de la búsqueda son una colección de objetos de intervalo.
select(selectionMode)

Selecciona la fila y se desplaza por la interfaz de usuario de Word hasta ella.
select(selectionModeString)

Selecciona la fila y se desplaza por la interfaz de usuario de Word hasta ella.
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.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.TableRow es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.TableRowData) 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

cellCount

Obtiene el número de celdas de la fila.

readonly cellCount: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.3 ]

cells

Obtiene celdas.

readonly cells: Word.TableCellCollection;

Valor de propiedad

Word.TableCellCollection

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}`);
});

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

fields

Obtiene la colección de objetos de campo de la fila de 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 ]

horizontalAlignment

Especifica la alineación horizontal de cada celda de la fila. 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 ]

isHeader

Comprueba si la fila es una fila de encabezado. Para establecer el número de filas de encabezado, use headerRowCount en el objeto Table.

readonly isHeader: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.3 ]

parentTable

Obtiene la tabla primaria.

readonly parentTable: Word.Table;

Valor de propiedad

Word.Table

Comentarios

[ Conjunto de API: WordApi 1.3 ]

preferredHeight

Especifica el alto preferido de la fila en puntos.

preferredHeight: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.3 ]

rowIndex

Obtiene el índice de la fila en la tabla primaria.

readonly rowIndex: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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 ]

values

Especifica los valores de texto de la fila, 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 las celdas de la fila. 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 ]

Detalles del método

clear()

Borra el contenido de la fila.

clear(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

delete()

Elimina toda la fila.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: WordApi 1.3 ]

getBorder(borderLocation)

Obtiene el estilo del borde de las celdas de la fila.

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 row 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 borderLocation = Word.BorderLocation.bottom;
  const border: Word.TableBorder = firstTableRow.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

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

getBorder(borderLocationString)

Obtiene el estilo del borde de las celdas de la fila.

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 ]

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 row 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 cellPaddingLocation = Word.CellPaddingLocation.bottom;
  const cellPadding = firstTableRow.getCellPadding(cellPaddingLocation);
  await context.sync();

  console.log(
    `Cell padding details about the ${cellPaddingLocation} border of the first table's first row: ${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"

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 ]

getNext()

Obtiene la fila siguiente. Produce un ItemNotFound error si esta fila es la última.

getNext(): Word.TableRow;

Devoluciones

Word.TableRow

Comentarios

[ Conjunto de API: WordApi 1.3 ]

getNextOrNullObject()

Obtiene la fila siguiente. Si esta fila 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.TableRow;

Devoluciones

Word.TableRow

Comentarios

[ Conjunto de API: WordApi 1.3 ]

insertRows(insertLocation, rowCount, values)

Inserta filas mediante esta fila como una plantilla. Si los valores se especifican, inserta los valores en las nuevas filas.

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

Parámetros

insertLocation

before | after | "Before" | "After"

Obligatorio. Donde se deben insertar las nuevas filas, en relación con la fila actual. Debe ser "Antes" o "Después".

rowCount

number

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

values

string[][]

Opcional. Cadenas que se van a insertar en las nuevas filas, especificadas como una matriz 2D. El número de celdas de cada fila no debe superar el número de celdas de la fila existente.

Devoluciones

Word.TableRowCollection

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.TableRowLoadOptions): Word.TableRow;

Parámetros

options
Word.Interfaces.TableRowLoadOptions

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

Devoluciones

Word.TableRow

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

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.TableRow

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

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.TableRow

merge()

Combina la fila en una celda.

merge(): Word.TableCell;

Devoluciones

Word.TableCell

Comentarios

[ Conjunto de API: WordApi 1.4 ]

search(searchText, searchOptions)

Realiza una búsqueda con las SearchOptions especificadas en el ámbito de la fila. 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 fila y se desplaza por la interfaz de usuario de Word hasta ella.

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 fila y se desplaza por la interfaz de usuario de Word hasta ella.

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

Parámetros

properties
Word.Interfaces.TableRowUpdateData

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

Parámetros

properties
Word.TableRow

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 objeto original Word.TableRow es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.TableRowData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.TableRowData;

Devoluciones

Word.Interfaces.TableRowData

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

Devoluciones

Word.TableRow

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

Devoluciones

Word.TableRow