Excel.WorksheetFreezePanes class

Extends

Свойства

context

Контекст запроса, связанный с объектом. Это подсоединяет процесс надстройки к процессу ведущего приложения Office.

Методы

freezeAt(frozenRange)

Задает закрепленные ячейки в представлении активного листа. Указанный диапазон соответствует ячейкам, которые будут заморожены в верхней и левой области.

[Набор API: ExcelApi 1,7]

freezeColumns(count)

Закрепляет первый столбец (или столбцы) листа на месте.

[Набор API: ExcelApi 1,7]

freezeRows(count)

Закрепляет верхнюю строку (или строки) листа на месте.

[Набор API: ExcelApi 1,7]

getLocation()

Получает диапазон, описывающий закрепленные ячейки в представлении активного листа. Замороженный диапазон соответствует ячейкам, замороженным в верхней и левой области.

[Набор API: ExcelApi 1,7]

getLocationOrNullObject()

Получает диапазон, описывающий закрепленные ячейки в представлении активного листа. Замороженный диапазон соответствует ячейкам, замороженным в верхней и левой области. Если нет замороженной области, возвращается пустой объект.

[Набор API: ExcelApi 1,7]

toJSON()

Переопределяет toJSON() метод JavaScript для предоставления более удобного вывода при передаче объекта APIJSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод объекта, который передается ему.) В то время как исходный объект Excel. Воркшитфризепанес — это объект API, toJSON метод возвращает простой объект JavaScript (типExcel.Interfaces.WorksheetFreezePanesData), который содержит неполные копии загруженных дочерних свойств из исходного объекта.

unfreeze()

Удаляет все закрепленные области в листе.

[Набор API: ExcelApi 1,7]

Сведения о свойстве

context

Контекст запроса, связанный с объектом. Это подсоединяет процесс надстройки к процессу ведущего приложения Office.

context: RequestContext;

Значение свойства

Сведения о методе

freezeAt(frozenRange)

Задает закрепленные ячейки в представлении активного листа. Указанный диапазон соответствует ячейкам, которые будут заморожены в верхней и левой области.

[Набор API: ExcelApi 1,7]

freezeAt(frozenRange: Range | string): void;

Параметры

frozenRange
Range | string

Диапазон, представляющий ячейки, которые должны быть заморожены, или значение NULL для удаления всех замороженных областей.

Возвращаемое значение

void

Примеры

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

Закрепляет первый столбец (или столбцы) листа на месте.

[Набор API: ExcelApi 1,7]

freezeColumns(count?: number): void;

Параметры

count
number

Необязательное количество столбцов для закрепления или ноль для освобождения всех столбцов

Возвращаемое значение

void

Примеры

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

Закрепляет верхнюю строку (или строки) листа на месте.

[Набор API: ExcelApi 1,7]

freezeRows(count?: number): void;

Параметры

count
number

Необязательное количество строк для закрепления или ноль для разморозки всех строк

Возвращаемое значение

void

Примеры

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

Получает диапазон, описывающий закрепленные ячейки в представлении активного листа. Замороженный диапазон соответствует ячейкам, замороженным в верхней и левой области.

[Набор API: ExcelApi 1,7]

getLocation(): Excel.Range;

Возвращаемое значение

getLocationOrNullObject()

Получает диапазон, описывающий закрепленные ячейки в представлении активного листа. Замороженный диапазон соответствует ячейкам, замороженным в верхней и левой области. Если нет замороженной области, возвращается пустой объект.

[Набор API: ExcelApi 1,7]

getLocationOrNullObject(): Excel.Range;

Возвращаемое значение

Примеры

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

Переопределяет toJSON() метод JavaScript для предоставления более удобного вывода при передаче объекта APIJSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод объекта, который передается ему.) В то время как исходный объект Excel. Воркшитфризепанес — это объект API, toJSON метод возвращает простой объект JavaScript (типExcel.Interfaces.WorksheetFreezePanesData), который содержит неполные копии загруженных дочерних свойств из исходного объекта.

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

Возвращаемое значение

{ [key: string]: string; }

unfreeze()

Удаляет все закрепленные области в листе.

[Набор API: ExcelApi 1,7]

unfreeze(): void;

Возвращаемое значение

void

Примеры

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