Excel.RangeFormat class

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 dentro del rango. Si los anchos de columna no son uniformes, null se devolverá.

columnWidth: number;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.2

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

Devuelve el objeto de relleno definido en el intervalo global.

readonly fill: Excel.RangeFill;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.1

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/formatting.yaml

// Set the fill color for the header range.
await Excel.run(async (context) => {
    const sheet: Excel.Worksheet = context.workbook.worksheets.getItem("Sample");
    const headerRange: Excel.Range = sheet.getRange("B2:E2");

    headerRange.format.fill.color = "#D9EAF7";

    await context.sync();
    console.log("The header fill color was updated.");
});

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

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotlayout.yaml

await Excel.run(async (context) => {
  // Set a default value for an empty cell in the PivotTable. This doesn't include cells left blank by the layout.
  const pivotTable = context.workbook.pivotTables.getItem("Farm Sales");
  const pivotLayout = pivotTable.layout;

  pivotLayout.emptyCellText = "--";

  // Set the text alignment to match the rest of the PivotTable.
  pivotLayout.getDataBodyRange().format.horizontalAlignment = Excel.HorizontalAlignment.right;
  await context.sync();
});

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 alto de todas las filas del rango. Si los altos de fila no son uniformes, null se devolverá.

rowHeight: number;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.2

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

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 new style.
    range.style = ("Diagonal Orientation Style");
    range.format.verticalAlignment = "Justify";

    await context.sync();
});

Especifica si Excel ajusta el texto en el objeto. Un null valor indica que el rango completo no tiene una configuración de ajuste uniforme

wrapText: boolean;

Valor de propiedad

Comentarios

Conjunto de API: ExcelApi 1.1

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

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    let range = sheet.getRange("B7");
    range.values = [[900]];
    range.format.autofitColumns();

    await context.sync();
    console.log("B7 value has been changed.");
});

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

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-advanced.yaml

function queueCommandsToCreateTemperatureTable(sheet: Excel.Worksheet) {
    let temperatureTable = sheet.tables.add('A1:M1', true);
    temperatureTable.name = "TemperatureTable";
    temperatureTable.getHeaderRowRange().values = [["Category", "Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"]];
    temperatureTable.rows.add(null, [
        ["Avg High", 40, 38, 44, 45, 51, 56, 67, 72, 79, 59, 45, 41],
        ["Avg Low", 34, 33, 38, 41, 45, 48, 51, 55, 54, 45, 41, 38],
        ["Record High", 61, 69, 79, 83, 95, 97, 100, 101, 94, 87, 72, 66],
        ["Record Low", -1, 2, 9, 24, 28, 32, 36, 39, 35, 21, 12, 4]
    ]);
    temperatureTable.getRange().format.autofitColumns();
    temperatureTable.getRange().format.autofitRows();
}

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

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

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Excel.RangeFormat): void;

Parámetros

Devoluciones

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.RangeFormat es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.RangeFormatData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.RangeFormatData;

Devoluciones