Excel.RangeFormat class

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

autoIndent: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Colección de objetos de borde que se aplica al rango global seleccionado.

readonly borders: Excel.RangeBorderCollection;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Especifica el ancho de todas las columnas del intervalo. Si los anchos de columna no son uniformes, null se devolverá.

columnWidth: number;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

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

Devuelve el objeto de relleno definido en el intervalo global.

readonly fill: Excel.RangeFill;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Devuelve el objeto de fuente definido en el rango global.

readonly font: Excel.RangeFont;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

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

horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Un número entero entre 0 y 250 que indica el nivel de sangría.

indentLevel: number;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Devuelve el objeto de protección de formato de un rango.

readonly protection: Excel.FormatProtection;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

El orden de lectura para el intervalo.

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

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Alto de todas las filas del intervalo. Si los altos de fila no son uniformes, null se devolverá.

rowHeight: number;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

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

shrinkToFit: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Orientación del texto de todas las celdas dentro del rango. La orientación del texto debe ser un entero de -90 a 90 o 180 para texto orientado verticalmente. Si la orientación dentro de un intervalo no es uniforme, null se devolverá.

textOrientation: number;

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/range-text-orientation.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const range = sheet.getRange("B2:E2");

    // Set textOrientation to either an integer between -90 and 90
    // or to 180 for vertically-oriented text.
    range.format.textOrientation = 90;

    await context.sync();
});

Determina si el alto de fila del Range objeto es igual al alto estándar de la hoja. Devuelve true si el alto de fila del Range objeto es igual al alto estándar de la hoja. Devuelve null si el intervalo contiene más de una fila y las filas no tienen el mismo alto. Devuelve false lo contrario. Nota: Esta propiedad solo está pensada para establecerse en true. Establecerlo en false no tiene ningún efecto.

useStandardHeight: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Especifica si el ancho de columna del Range objeto es igual al ancho estándar de la hoja. Devuelve true si el ancho de columna del Range objeto es igual al ancho estándar de la hoja. Devuelve null si el intervalo contiene más de una columna y las columnas no tienen el mismo alto. Devuelve false lo contrario. Nota: Esta propiedad solo está pensada para establecerse en true. Establecerlo en false no tiene ningún efecto.

useStandardWidth: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Representa la alineación vertical del objeto especificado. Vea Excel.VerticalAlignment para más información.

verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Especifica si Excel ajusta el texto del objeto. Un null valor indica que todo el intervalo no tiene una configuración de ajuste uniforme

wrapText: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ajusta la sangría del formato de intervalo. El valor de sangría oscila entre 0 y 250 y se mide en caracteres.

adjustIndent(amount: number): void;

Parámetros

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.11 ]

Cambia el ancho de las columnas del rango actual para obtener el ajuste perfecto (según los datos actuales de las columnas).

autofitColumns(): void;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

Cambia el alto de las filas del rango actual para obtener el ajuste perfecto (según los datos actuales de las columnas).

autofitRows(): void;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.2 ]

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.RangeFormatLoadOptions): Excel.RangeFormat;

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[]): Excel.RangeFormat;

Parámetros

Devoluciones

Ejemplos

// Select all of the range's format properties.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load(["format/*", "format/fill", "format/borders", "format/font"]);
    await context.sync();
    
    console.log(range.format.wrapText);
    console.log(range.format.fill.color);
    console.log(range.format.font.name);
});

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.RangeFormat;

Parámetros

Devoluciones

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.RangeFormatUpdateData, 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: Excel.RangeFormat): void;

Parámetros

Devoluciones

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

toJSON(): Excel.Interfaces.RangeFormatData;

Devoluciones