Excel.WorksheetFreezePanes class

Extends

Propriedades

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

Métodos

freezeAt(frozenRange)

Define as células congeladas no modo de exibição da planilha ativa. O intervalo fornecido corresponde a células que serão congeladas no painel superior e à esquerda.

[Conjunto de APIs: ExcelApi 1,7]

freezeColumns(count)

Congela a primeira colunas da planilha no local.

[Conjunto de APIs: ExcelApi 1,7]

freezeRows(count)

Congela as linhas superiores da planilha no local.

[Conjunto de APIs: ExcelApi 1,7]

getLocation()

Obtém um intervalo que descreve as células congeladas no modo de exibição da planilha ativa. O intervalo congelado corresponde às células que estão congeladas no painel superior e à esquerda.

[Conjunto de APIs: ExcelApi 1,7]

getLocationOrNullObject()

Obtém um intervalo que descreve as células congeladas no modo de exibição da planilha ativa. O intervalo congelado corresponde às células que estão congeladas no painel superior e à esquerda. Se não houver nenhum painel congelado, retorna um objeto NULL.

[Conjunto de APIs: ExcelApi 1,7]

toJSON()

Substitui o toJSON() método JavaScript para fornecer uma saída mais útil quando um objeto API é passado paraJSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel. WorksheetFreezePanes original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado comoExcel.Interfaces.WorksheetFreezePanesData) que contém cópias superficiais de qualquer propriedade filho carregada do objeto original.

unfreeze()

Remove todos os painéis congelados na planilha.

[Conjunto de APIs: ExcelApi 1,7]

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Detalhes do método

freezeAt(frozenRange)

Define as células congeladas no modo de exibição da planilha ativa. O intervalo fornecido corresponde a células que serão congeladas no painel superior e à esquerda.

[Conjunto de APIs: ExcelApi 1,7]

freezeAt(frozenRange: Range | string): void;

Parâmetros

frozenRange
Range | string

Um intervalo que representa as células a serem congeladas ou nulo para remover todos os painéis congelados.

Retornos

void

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/master/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)

Congela a primeira colunas da planilha no local.

[Conjunto de APIs: ExcelApi 1,7]

freezeColumns(count?: number): void;

Parâmetros

count
number

Número opcional de colunas a serem congeladas ou zero para descongelar todas as colunas

Retornos

void

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/master/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)

Congela as linhas superiores da planilha no local.

[Conjunto de APIs: ExcelApi 1,7]

freezeRows(count?: number): void;

Parâmetros

count
number

Número opcional de linhas a serem congeladas ou zero para descongelar todas as linhas

Retornos

void

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/master/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()

Obtém um intervalo que descreve as células congeladas no modo de exibição da planilha ativa. O intervalo congelado corresponde às células que estão congeladas no painel superior e à esquerda.

[Conjunto de APIs: ExcelApi 1,7]

getLocation(): Excel.Range;

Retornos

getLocationOrNullObject()

Obtém um intervalo que descreve as células congeladas no modo de exibição da planilha ativa. O intervalo congelado corresponde às células que estão congeladas no painel superior e à esquerda. Se não houver nenhum painel congelado, retorna um objeto NULL.

[Conjunto de APIs: ExcelApi 1,7]

getLocationOrNullObject(): Excel.Range;

Retornos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/master/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()

Substitui o toJSON() método JavaScript para fornecer uma saída mais útil quando um objeto API é passado paraJSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel. WorksheetFreezePanes original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado comoExcel.Interfaces.WorksheetFreezePanesData) que contém cópias superficiais de qualquer propriedade filho carregada do objeto original.

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

Retornos

{ [key: string]: string; }

unfreeze()

Remove todos os painéis congelados na planilha.

[Conjunto de APIs: ExcelApi 1,7]

unfreeze(): void;

Retornos

void

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/master/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();
});