Word.TableStyle class
Representa el objeto TableStyle.
- Extends
Comentarios
[ Conjunto de API: WordApi 1.6 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml
// Gets the table style properties and displays them in the form.
const styleName = $("#style-name")
.val()
.toString();
if (styleName == "") {
console.warn("Please input a table style name.");
return;
}
await Word.run(async (context) => {
const tableStyle: Word.TableStyle = context.document.getStyles().getByName(styleName).tableStyle;
tableStyle.load();
await context.sync();
if (tableStyle.isNullObject) {
console.warn(`There's no existing table style with the name '${styleName}'.`);
return;
}
console.log(tableStyle);
$("#alignment").val(tableStyle.alignment);
$("#allow-break-across-page").val(tableStyle.allowBreakAcrossPage.toString());
$("#top-cell-margin").val(tableStyle.topCellMargin);
$("#bottom-cell-margin").val(tableStyle.bottomCellMargin);
$("#left-cell-margin").val(tableStyle.leftCellMargin);
$("#right-cell-margin").val(tableStyle.rightCellMargin);
$("#cell-spacing").val(tableStyle.cellSpacing);
});
Propiedades
| alignment | Especifica la alineación de la tabla con respecto al margen de página. |
| allow |
Especifica si las líneas de las tablas con formato con un estilo especificado se dividen entre páginas. |
| bottom |
Especifica la cantidad de espacio que se va a agregar entre el contenido y los bordes inferiores de las celdas. |
| cell |
Especifica el espaciado (en puntos) entre las celdas de un estilo de tabla. |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| left |
Especifica la cantidad de espacio que se va a agregar entre el contenido y los bordes izquierdos de las celdas. |
| right |
Especifica la cantidad de espacio que se va a agregar entre el contenido y los bordes derecho de las celdas. |
| top |
Especifica la cantidad de espacio que se va a agregar entre el contenido y los bordes superiores de las celdas. |
Métodos
| 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. |
| 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
alignment
Especifica la alineación de la tabla con respecto al margen de página.
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";Valor de propiedad
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Comentarios
allowBreakAcrossPage
Especifica si las líneas de las tablas con formato con un estilo especificado se dividen entre páginas.
allowBreakAcrossPage: boolean;Valor de propiedad
boolean
Comentarios
bottomCellMargin
Especifica la cantidad de espacio que se va a agregar entre el contenido y los bordes inferiores de las celdas.
bottomCellMargin: number;Valor de propiedad
number
Comentarios
cellSpacing
Especifica el espaciado (en puntos) entre las celdas de un estilo de tabla.
cellSpacing: 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
leftCellMargin
Especifica la cantidad de espacio que se va a agregar entre el contenido y los bordes izquierdos de las celdas.
leftCellMargin: number;Valor de propiedad
number
Comentarios
rightCellMargin
Especifica la cantidad de espacio que se va a agregar entre el contenido y los bordes derecho de las celdas.
rightCellMargin: number;Valor de propiedad
number
Comentarios
topCellMargin
Especifica la cantidad de espacio que se va a agregar entre el contenido y los bordes superiores de las celdas.
topCellMargin: number;Valor de propiedad
number
Comentarios
Detalles del método
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.TableStyleLoadOptions): Word.TableStyle;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.TableStyle;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.TableStyle;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.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Word.Interfaces.TableStyleUpdateData
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.TableStyle): void;Parámetros
- properties
- Word.TableStyle
Devoluciones
void
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.TableStyle es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.TableStyleData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Word.Interfaces.TableStyleData;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.TableStyle;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.TableStyle;