Excel.Style class

Objeto que encapsula el formato de un estilo y otras propiedades.

Extends

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Propiedades

autoIndent

Especifica si el texto se aplica sangría automáticamente cuando la alineación de texto de una celda se establece en la misma distribución.

borders

Colección de cuatro objetos de borde que representan el estilo de los cuatro bordes.

builtIn

Especifica si el estilo es un estilo integrado.

context

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

fill

Relleno del estilo.

font

Objeto Font que representa la fuente del estilo.

formulaHidden

Especifica si la fórmula se ocultará cuando la hoja de cálculo esté protegida.

horizontalAlignment

Representa la alineación horizontal del estilo. Vea Excel.HorizontalAlignment para más información.

includeAlignment

Especifica si el estilo incluye las propiedades de sangría automática, alineación horizontal, alineación vertical, texto de ajuste, nivel de sangría y orientación del texto.

includeBorder

Especifica si el estilo incluye las propiedades de color, índice de color, estilo de línea y borde de peso.

includeFont

Especifica si el estilo incluye las propiedades de fondo, negrita, color, índice de color, estilo de fuente, cursiva, nombre, tamaño, tachado, subíndice, superíndice y subrayado.

includeNumber

Especifica si el estilo incluye la propiedad de formato de número.

includePatterns

Especifica si el estilo incluye el color, el índice de color, la inversión si es negativo, el patrón, el color del patrón y las propiedades interiores del índice de color del patrón.

includeProtection

Especifica si el estilo incluye las propiedades de protección ocultas y bloqueadas de la fórmula.

indentLevel

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.

numberFormat

El código de formato del formato de número para el estilo.

numberFormatLocal

El código de formato localizado del formato de número para el estilo.

readingOrder

El orden de lectura para el estilo.

shrinkToFit

Especifica si el texto se reduce automáticamente para ajustarse al ancho de columna disponible.

textOrientation

Orientación del texto para el estilo.

verticalAlignment

Especifica la alineación vertical del estilo. Vea Excel.VerticalAlignment para más información.

wrapText

Especifica si Excel ajusta el texto del objeto.

Métodos

delete()

Elimina este estilo.

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.

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

Detalles de las propiedades

autoIndent

Especifica si el texto se aplica sangría automáticamente cuando la alineación de texto de una celda se establece en la misma distribución.

autoIndent: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

borders

Colección de cuatro objetos de borde que representan el estilo de los cuatro bordes.

readonly borders: Excel.RangeBorderCollection;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

builtIn

Especifica si el estilo es un estilo integrado.

readonly builtIn: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

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

fill

Relleno del estilo.

readonly fill: Excel.RangeFill;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

font

Objeto Font que representa la fuente del estilo.

readonly font: Excel.RangeFont;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

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

[ Conjunto de API: ExcelApi 1.7 ]

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

[ Conjunto de API: ExcelApi 1.7 ]

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, texto de ajuste, nivel de sangría y orientación del texto.

includeAlignment: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

includeBorder

Especifica si el estilo incluye las propiedades de color, índice de color, estilo de línea y borde de peso.

includeBorder: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

includeFont

Especifica si el estilo incluye las propiedades 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

[ Conjunto de API: ExcelApi 1.7 ]

includeNumber

Especifica si el estilo incluye la propiedad de formato de número.

includeNumber: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

includePatterns

Especifica si el estilo incluye el color, el índice de color, la inversión si es negativo, el patrón, el color del patrón y las propiedades interiores del índice de color del patrón.

includePatterns: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

includeProtection

Especifica si el estilo incluye las propiedades de protección ocultas y bloqueadas de la fórmula.

includeProtection: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

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

[ Conjunto de API: ExcelApi 1.7 ]

locked

Especifica si el objeto está bloqueado cuando la hoja de cálculo está protegida.

locked: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

name

El nombre del estilo.

readonly name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

numberFormat

El código de formato del formato de número para el estilo.

numberFormat: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

numberFormatLocal

El código de formato localizado del formato de número para el estilo.

numberFormatLocal: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

readingOrder

El orden de lectura para el estilo.

readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

Valor de propiedad

Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

shrinkToFit

Especifica si el texto se reduce automáticamente para ajustarse al ancho de columna disponible.

shrinkToFit: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

textOrientation

Orientación del texto para el estilo.

textOrientation: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.8 ]

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

[ Conjunto de API: ExcelApi 1.7 ]

wrapText

Especifica si Excel ajusta el texto del objeto.

wrapText: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Detalles del método

delete()

Elimina este estilo.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

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

options
Excel.Interfaces.StyleLoadOptions

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 de API del mismo tipo.

set(properties: Interfaces.StyleUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties
Excel.Interfaces.StyleUpdateData

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

Parámetros

properties
Excel.Style

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

toJSON(): Excel.Interfaces.StyleData;

Devoluciones