Excel.WorksheetFreezePanes class

  • Referencia
Paquete:
excel
Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Propiedades

context

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

Métodos

freezeAt(frozenRange)

Establece las celdas inmovilizadas en la vista de la hoja de cálculo activa. El rango proporcionado corresponde a las celdas que se inmovilizarán en el panel superior e izquierdo.
freezeColumns(count)

Inmovilizar la primera columna o columnas de la hoja de cálculo en su lugar.
freezeRows(count)

Inmovilizar la fila superior o las filas de la hoja de cálculo en su lugar.
getLocation()

Obtiene un rango que describe las celdas bloqueadas en la vista de hoja de cálculo activa. El intervalo inmovilizado corresponde a las celdas que están inmovilizadas en el panel superior e izquierdo.
getLocationOrNullObject()

Obtiene un rango que describe las celdas bloqueadas en la vista de hoja de cálculo activa. El intervalo inmovilizado corresponde a las celdas que están inmovilizadas en el panel superior e izquierdo. Si no hay ningún panel inmovilizado, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).
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 Excel.WorksheetFreezePanes original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WorksheetFreezePanesData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
unfreeze()

Elimina todos los paneles inmovilizados de la hoja de cálculo.

Detalles de las propiedades

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

Excel.RequestContext

Detalles del método

freezeAt(frozenRange)

Establece las celdas inmovilizadas en la vista de la hoja de cálculo activa. El rango proporcionado corresponde a las celdas que se inmovilizarán en el panel superior e izquierdo.

freezeAt(frozenRange: Range | string): void;

Parámetros

frozenRange

Excel.Range | string

Rango que representa las celdas que se van a inmovilizar o null para quitar todos los paneles inmovilizados.

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/54-worksheet/worksheet-freeze-panes.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    // Freeze the specified range in top-and-left-most pane of the worksheet.
    sheet.freezePanes.freezeAt(sheet.getRange("H2:K5"));

    await context.sync();
});

freezeColumns(count)

Inmovilizar la primera columna o columnas de la hoja de cálculo en su lugar.

freezeColumns(count?: number): void;

Parámetros

count

number

Número opcional de columnas que se inmovilizan o cero para descongelar todas las columnas

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/54-worksheet/worksheet-freeze-panes.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    // Freeze the first two columns in the worksheet.
    sheet.freezePanes.freezeColumns(2);

    await context.sync();
});

freezeRows(count)

Inmovilizar la fila superior o las filas de la hoja de cálculo en su lugar.

freezeRows(count?: number): void;

Parámetros

count

number

Número opcional de filas que se inmovilizan o cero para descongelar todas las filas

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/54-worksheet/worksheet-freeze-panes.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    // Freeze the top two rows in the worksheet.
    sheet.freezePanes.freezeRows(2);

    await context.sync();
});

getLocation()

Obtiene un rango que describe las celdas bloqueadas en la vista de hoja de cálculo activa. El intervalo inmovilizado corresponde a las celdas que están inmovilizadas en el panel superior e izquierdo.

getLocation(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

getLocationOrNullObject()

Obtiene un rango que describe las celdas bloqueadas en la vista de hoja de cálculo activa. El intervalo inmovilizado corresponde a las celdas que están inmovilizadas en el panel superior e izquierdo. Si no hay ningún panel inmovilizado, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getLocationOrNullObject(): Excel.Range;

Devoluciones

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-freeze-panes.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const frozenRange = sheet.freezePanes.getLocationOrNullObject();
    frozenRange.load("address");

    await context.sync();

    if (frozenRange.isNullObject) {
        console.log(`The worksheet does not contain a frozen pane.`);
    } else {
        console.log(`The address of the frozen range (cells that are frozen in the top-and-left-most pane) is "${frozenRange.address}"`);
    }
});

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

toJSON(): {
            [key: string]: string;
        };

Devoluciones

{ [key: string]: string; }

unfreeze()

Elimina todos los paneles inmovilizados de la hoja de cálculo.

unfreeze(): 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/54-worksheet/worksheet-freeze-panes.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.freezePanes.unfreeze();

    await context.sync();
});