Excel.Style class
Objeto que encapsula el formato de un estilo y otras propiedades.
- Extends
Comentarios
Usada por
Propiedades
| auto |
Especifica si el texto se aplica automáticamente cuando la alineación del texto de una celda se establece en distribución igual. |
| borders | Una colección de cuatro objetos de borde que representan el estilo de los cuatro bordes. |
| built |
Especifica si el estilo es un estilo integrado. |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| fill | El relleno del estilo. |
| font | Objeto |
| formula |
Especifica si la fórmula se ocultará cuando la hoja de cálculo esté protegida. |
| horizontal |
Representa la alineación horizontal del estilo. Vea |
| include |
Especifica si el estilo incluye las propiedades de sangría automática, alineación horizontal, alineación vertical, ajustar texto, nivel de sangría y orientación del texto. |
| include |
Especifica si el estilo incluye las propiedades color, índice de color, estilo de línea y grosor del borde. |
| include |
Especifica si el estilo incluye las propiedades de fuente de fondo, negrita, color, índice de color, estilo de fuente, cursiva, nombre, tamaño, tachado, subíndice, superíndice y subrayado. |
| include |
Especifica si el estilo incluye la propiedad de formato de número. |
| include |
Especifica si el estilo incluye las propiedades interiores color, índice de color, invertir si es negativo, patrón, color de patrón e índice de color de trama. |
| include |
Especifica si el estilo incluye las propiedades de protección Fórmula oculta y Bloqueada. |
| indent |
Un número entero entre 0 y 250 que indica el nivel de sangría para el estilo. |
| locked | Especifica si el objeto está bloqueado cuando la hoja de cálculo está protegida. |
| name | El nombre del estilo. |
| number |
El código de formato del formato de número para el estilo. |
| number |
El código de formato localizado del formato de número para el estilo. |
| reading |
El orden de lectura para el estilo. |
| shrink |
Especifica si el texto se contrae automáticamente para ajustarse al ancho de columna disponible. |
| text |
Orientación del texto para el estilo. |
| vertical |
Especifica la alineación vertical del estilo. Vea |
| wrap |
Especifica si Excel ajusta el texto en el objeto. |
Métodos
| delete() | Elimina este estilo. |
| 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 API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| toJSON() | Reemplaza el método JavaScript |
Detalles de las propiedades
autoIndent
Especifica si el texto se aplica automáticamente cuando la alineación del texto de una celda se establece en distribución igual.
autoIndent: boolean;Valor de propiedad
boolean
Comentarios
borders
Una colección de cuatro objetos de borde que representan el estilo de los cuatro bordes.
readonly borders: Excel.RangeBorderCollection;Valor de propiedad
Comentarios
builtIn
Especifica si el estilo es un estilo integrado.
readonly builtIn: boolean;Valor de propiedad
boolean
Comentarios
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
fill
El relleno del estilo.
readonly fill: Excel.RangeFill;Valor de propiedad
Comentarios
font
Objeto Font que representa la fuente del estilo.
readonly font: Excel.RangeFont;Valor de propiedad
Comentarios
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let style = context.workbook.styles.getItem("Normal");
style.font.load("bold, color, italic, name, size");
style.fill.load("color");
await context.sync();
console.log("Bold: " + style.font.bold);
console.log("Font color: " + style.font.color);
console.log("Italic: " + style.font.italic);
console.log("Name: " + style.font.name);
console.log("Size: " + style.font.size);
console.log("Fill color: " + style.fill.color);
});
formulaHidden
Especifica si la fórmula se ocultará cuando la hoja de cálculo esté protegida.
formulaHidden: boolean;Valor de propiedad
boolean
Comentarios
horizontalAlignment
Representa la alineación horizontal del estilo. Vea Excel.HorizontalAlignment para más información.
horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";Valor de propiedad
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
Comentarios
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let worksheet = context.workbook.worksheets.getItem("Sample");
let range = worksheet.getRange("A1:E1");
// Apply built-in style.
// Styles are in the Home tab ribbon.
range.style = Excel.BuiltInStyle.neutral;
range.format.horizontalAlignment = "Right";
await context.sync();
});
includeAlignment
Especifica si el estilo incluye las propiedades de sangría automática, alineación horizontal, alineación vertical, ajustar texto, nivel de sangría y orientación del texto.
includeAlignment: boolean;Valor de propiedad
boolean
Comentarios
includeBorder
Especifica si el estilo incluye las propiedades color, índice de color, estilo de línea y grosor del borde.
includeBorder: boolean;Valor de propiedad
boolean
Comentarios
includeFont
Especifica si el estilo incluye las propiedades de fuente de fondo, negrita, color, índice de color, estilo de fuente, cursiva, nombre, tamaño, tachado, subíndice, superíndice y subrayado.
includeFont: boolean;Valor de propiedad
boolean
Comentarios
includeNumber
Especifica si el estilo incluye la propiedad de formato de número.
includeNumber: boolean;Valor de propiedad
boolean
Comentarios
includePatterns
Especifica si el estilo incluye las propiedades interiores color, índice de color, invertir si es negativo, patrón, color de patrón e índice de color de trama.
includePatterns: boolean;Valor de propiedad
boolean
Comentarios
includeProtection
Especifica si el estilo incluye las propiedades de protección Fórmula oculta y Bloqueada.
includeProtection: boolean;Valor de propiedad
boolean
Comentarios
indentLevel
Un número entero entre 0 y 250 que indica el nivel de sangría para el estilo.
indentLevel: number;Valor de propiedad
number
Comentarios
locked
Especifica si el objeto está bloqueado cuando la hoja de cálculo está protegida.
locked: boolean;Valor de propiedad
boolean
Comentarios
name
El nombre del estilo.
readonly name: string;Valor de propiedad
string
Comentarios
numberFormat
El código de formato del formato de número para el estilo.
numberFormat: string;Valor de propiedad
string
Comentarios
numberFormatLocal
El código de formato localizado del formato de número para el estilo.
numberFormatLocal: string;Valor de propiedad
string
Comentarios
readingOrder
El orden de lectura para el estilo.
readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";Valor de propiedad
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
Comentarios
shrinkToFit
Especifica si el texto se contrae automáticamente para ajustarse al ancho de columna disponible.
shrinkToFit: boolean;Valor de propiedad
boolean
Comentarios
textOrientation
Orientación del texto para el estilo.
textOrientation: number;Valor de propiedad
number
Comentarios
verticalAlignment
Especifica la alineación vertical del estilo. Vea Excel.VerticalAlignment para más información.
verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";Valor de propiedad
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
Comentarios
wrapText
Especifica si Excel ajusta el texto en el objeto.
wrapText: boolean;Valor de propiedad
boolean
Comentarios
Detalles del método
delete()
Elimina este estilo.
delete(): void;Devoluciones
void
Comentarios
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let style = context.workbook.styles.getItem("Diagonal Orientation Style");
// Delete the diagonal orientation style from the style collection.
// Styles are in the Home tab ribbon.
style.delete();
await context.sync();
console.log("Successfully deleted the diagonal orientation style from the Home tab ribbon.");
});
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?: Excel.Interfaces.StyleLoadOptions): Excel.Style;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml
await Excel.run(async (context) => {
let style = context.workbook.styles.getItem("Diagonal Orientation Style");
style.load("textOrientation, horizontalAlignment, autoIndent, readingOrder, wrapText, includeProtection, shrinkToFit, locked");
await context.sync();
console.log("Orientation: " + style.textOrientation);
console.log("Horizontal alignment: " + style.horizontalAlignment);
console.log("Add indent: " + style.autoIndent);
console.log("Reading order: " + style.readingOrder);
console.log("Wrap text: " + style.wrapText);
console.log("Include protection: " + style.includeProtection);
console.log("Shrink to fit: " + style.shrinkToFit);
console.log("Style locked: " + style.locked);
});
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[]): Excel.Style;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;
}): Excel.Style;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 API del mismo tipo.
set(properties: Interfaces.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.StyleUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el 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, basadas en un objeto cargado existente.
set(properties: Excel.Style): void;Parámetros
- properties
- Excel.Style
Devoluciones
void
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Style es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.StyleData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.StyleData;