Excel.WorksheetFreezePanes class

  • Ссылка
Пакет:
excel
Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.7 ]

Свойства

context

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

Методы

freezeAt(frozenRange)

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

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

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

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

Получает диапазон, описывающий закрепленные ячейки в представлении активного листа. Замороженный диапазон соответствует ячейкам, которые заморожены в верхней и левой области. Если застывшей области нет, этот метод возвращает объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
toJSON()

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

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

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

context

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

context: RequestContext;

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

Excel.RequestContext

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

freezeAt(frozenRange)

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

freezeAt(frozenRange: Range | string): void;

Параметры

frozenRange

Excel.Range | string

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

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

void

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

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

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

freezeColumns(count?: number): void;

Параметры

count

number

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

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

void

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

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

Зафиксируете верхнюю строку или строки листа на месте.

freezeRows(count?: number): void;

Параметры

count

number

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

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

void

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

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

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

getLocation(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.7 ]

getLocationOrNullObject()

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

getLocationOrNullObject(): Excel.Range;

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

Excel.Range

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

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

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

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

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

{ [key: string]: string; }

unfreeze()

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

unfreeze(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.7 ]

Примеры

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