Compartilhar via

Excel.WorksheetFreezePanes class

  • Referência
Pacote:
excel
Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Propriedades

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

Métodos

freezeAt(frozenRange)

Define as células congeladas no modo de exibição da planilha ativa. O intervalo fornecido corresponde às células que serão bloqueadas no painel superior e esquerdo.
freezeColumns(count)

Fixar a primeira coluna ou colunas da folha de cálculo no local.
freezeRows(count)

Fixar a linha ou linhas superiores da folha de cálculo no local.
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 fixas no painel superior e esquerdo.
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 fixas no painel superior e esquerdo. Se não existir nenhum painel congelado, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.WorksheetFreezePanes é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorksheetFreezePanesData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
unfreeze()

Remove todos os painéis congelados na planilha.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

Detalhes do método

freezeAt(frozenRange)

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

freezeAt(frozenRange: Range | string): void;

Parâmetros

frozenRange

Excel.Range | string

Um intervalo que representa as células a fixar ou null para remover todos os painéis congelados.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// 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)

Fixar a primeira coluna ou colunas da folha de cálculo no local.

freezeColumns(count?: number): void;

Parâmetros

count

number

Número opcional de colunas a fixar ou zero para desbloquear todas as colunas

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// 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)

Fixar a linha ou linhas superiores da folha de cálculo no local.

freezeRows(count?: number): void;

Parâmetros

count

number

Número opcional de linhas a fixar ou zero para desbloquear todas as linhas

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// 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()

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 fixas no painel superior e esquerdo.

getLocation(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: 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 fixas no painel superior e esquerdo. Se não existir nenhum painel congelado, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getLocationOrNullObject(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// 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()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.WorksheetFreezePanes é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorksheetFreezePanesData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

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

Retornos

{ [key: string]: string; }

unfreeze()

Remove todos os painéis congelados na planilha.

unfreeze(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Exemplos

// 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();
});