Excel.WorksheetFreezePanes class
- Extends
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
Методы
| freeze |
Задает закрепленные ячейки в представлении активного листа. Предоставленный диапазон соответствует ячейкам, которые будут закреплены в верхней и левой областях. |
| freeze |
Закрепление первого столбца или столбцов листа на месте. |
| freeze |
Закрепление верхней строки или строк листа на месте. |
| get |
Получает диапазон, описывающий закрепленные ячейки в представлении активного листа. Закрепленный диапазон соответствует ячейкам, закрепленным в верхней и левой областях. |
| get |
Получает диапазон, описывающий закрепленные ячейки в представлении активного листа. Закрепленный диапазон соответствует ячейкам, закрепленным в верхней и левой областях. Если закрепленной области нет, этот метод возвращает объект со свойством |
| toJSON() | Переопределяет метод JavaScript |
| unfreeze() | Удаляет все закрепленные области в листе. |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
Сведения о методе
freezeAt(frozenRange)
Задает закрепленные ячейки в представлении активного листа. Предоставленный диапазон соответствует ячейкам, которые будут закреплены в верхней и левой областях.
freezeAt(frozenRange: Range | string): void;Параметры
- frozenRange
-
Excel.Range | string
Диапазон, представляющий ячейки, которые нужно закрепить или null удалить все закрепленные области.
Возвращаемое значение
void
Комментарии
Примеры
// 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
Комментарии
Примеры
// 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
Комментарии
Примеры
// 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;Возвращаемое значение
Комментарии
getLocationOrNullObject()
Получает диапазон, описывающий закрепленные ячейки в представлении активного листа. Закрепленный диапазон соответствует ячейкам, закрепленным в верхней и левой областях. Если закрепленной области нет, этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getLocationOrNullObject(): Excel.Range;Возвращаемое значение
Комментарии
Примеры
// 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
Комментарии
Примеры
// 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();
});