Word.TableRow class
Representa una fila de un documento Word.
- Extends
Comentarios
[ Conjunto de API: WordApi 1.3 ]
Propiedades
| cell |
Obtiene el número de celdas de la fila. |
| cells | Obtiene celdas. Solo lectura. |
| 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 fila de tabla. |
| 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. |
| footnotes | Obtiene la colección de notas al pie de la fila de tabla. |
| horizontal |
Especifica la alineación horizontal de cada celda de la fila. El valor puede ser "Left", "Centered", "Right" o "Justified". |
| is |
Comprueba si la fila es una fila de encabezado. Para establecer el número de filas de encabezado, use |
| parent |
Obtiene la tabla primaria. |
| preferred |
Especifica el alto preferido de la fila en puntos. |
| row |
Obtiene el índice de la fila en la tabla primaria. |
| shading |
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. |
| vertical |
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. |
| get |
Obtiene el estilo del borde de las celdas de la fila. |
| get |
Obtiene el estilo del borde de las celdas de la fila. |
| get |
Obtiene el espaciado entre borde y texto en puntos. |
| get |
Obtiene el espaciado entre borde y texto en puntos. |
| get |
Obtiene la fila siguiente. Produce un |
| get |
Obtiene la fila siguiente. Si esta fila es la última, este método devolverá un objeto con su |
| insert |
Inserta un control de contenido en la fila. |
| insert |
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 |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| merge() | Combina la fila en una celda. |
| search(search |
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(selection |
Selecciona la fila y se desplaza por la interfaz de usuario de Word hasta ella. |
| select(selection |
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. |
| set |
Establece el espaciado entre borde y texto en puntos. |
| set |
Establece el espaciado entre borde y texto en puntos. |
| 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
cellCount
Obtiene el número de celdas de la fila.
readonly cellCount: number;Valor de propiedad
number
Comentarios
cells
Obtiene celdas. Solo lectura.
readonly cells: Word.TableCellCollection;Valor de propiedad
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
endnotes
Obtiene la colección de notas al final de la fila de tabla.
readonly endnotes: Word.NoteItemCollection;Valor de propiedad
Comentarios
fields
Obtiene la colección de objetos de campo de la fila de tabla.
readonly fields: Word.FieldCollection;Valor de propiedad
Comentarios
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
Comentarios
footnotes
Obtiene la colección de notas al pie de la fila de tabla.
readonly footnotes: Word.NoteItemCollection;Valor de propiedad
Comentarios
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
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
parentTable
Obtiene la tabla primaria.
readonly parentTable: Word.Table;Valor de propiedad
Comentarios
preferredHeight
Especifica el alto preferido de la fila en puntos.
preferredHeight: number;Valor de propiedad
number
Comentarios
rowIndex
Obtiene el índice de la fila en la tabla primaria.
readonly rowIndex: number;Valor de propiedad
number
Comentarios
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
values
Especifica los valores de texto de la fila, como una matriz de JavaScript 2D.
values: string[][];Valor de propiedad
string[][]
Comentarios
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
Detalles del método
clear()
Borra el contenido de la fila.
clear(): void;Devoluciones
void
Comentarios
delete()
Elimina toda la fila.
delete(): void;Devoluciones
void
Comentarios
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
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 = context.document.body.tables.getFirst();
const firstTableRow = firstTable.rows.getFirst();
const borderLocation = Word.BorderLocation.bottom;
const border = 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:`);
console.log(`- Color: ${border.color}`);
console.log(`- Type: ${border.type}`);
console.log(`- 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
Comentarios
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 = context.document.body.tables.getFirst();
const firstTableRow = 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
getNext()
Obtiene la fila siguiente. Produce un ItemNotFound error si esta fila es la última.
getNext(): Word.TableRow;Devoluciones
Comentarios
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
Comentarios
insertContentControl()
Nota
Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.
Inserta un control de contenido en la fila.
insertContentControl(): Word.ContentControl;Devoluciones
Comentarios
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
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
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.TableRowLoadOptions): Word.TableRow;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.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
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
merge()
Combina la fila en una celda.
merge(): Word.TableCell;Devoluciones
Comentarios
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
Comentarios
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
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
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
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
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 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
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
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
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de