Word.TableRow class

Obtiene el número de celdas de la fila.

readonly cellCount: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Obtiene celdas.

readonly cells: Word.TableCellCollection;

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

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

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

readonly endnotes: Word.NoteItemCollection;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.5 ]

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

readonly fields: Word.FieldCollection;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.4 ]

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

readonly footnotes: Word.NoteItemCollection;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.5 ]

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Obtiene la tabla primaria.

readonly parentTable: Word.Table;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Especifica el alto preferido de la fila en puntos.

preferredHeight: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

readonly rowIndex: number;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

shadingColor: string;

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

values: string[][];

Valor de propiedad

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Borra el contenido de la fila.

clear(): void;

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Elimina toda la fila.

delete(): void;

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;

Parámetros

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

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

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Obtiene el espaciado entre borde y texto en puntos.

getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;

Parámetros

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

Obtiene el espaciado entre borde y texto en puntos.

getCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

getNext(): Word.TableRow;

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Inserta un control de contenido en la fila.

insertContentControl(): Word.ContentControl;

Devoluciones

Comentarios

[ Conjunto de API: WordApiDesktop 1.1 ]

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

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Devoluciones

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

Devoluciones

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

Devoluciones

Combina la fila en una celda.

merge(): Word.TableCell;

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.4 ]

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

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Selecciona la fila y se desplaza por la interfaz de usuario de Word hasta ella.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Selecciona la fila y se desplaza por la interfaz de usuario de Word hasta ella.

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

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Word.TableRow): void;

Parámetros

Devoluciones

Establece el espaciado entre borde y texto en puntos.

setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

Establece el espaciado entre borde y texto en puntos.

setCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: WordApi 1.3 ]

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

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

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