Excel.WorksheetFreezePanes class
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
方法
| freeze |
设置活动工作表视图中的冻结单元格。 提供的区域对应于将冻结在最顶部和最左侧窗格中的单元格。 |
| freeze |
将工作表的第一列或多列冻结到位。 |
| freeze |
将工作表的上一行或多行冻结到位。 |
| get |
获取用于描述活动工作表视图中的冻结单元格的区域。 冻结区域对应于冻结在最顶部和最左侧窗格中的单元格。 |
| get |
获取用于描述活动工作表视图中的冻结单元格的区域。 冻结区域对应于冻结在最顶部和最左侧窗格中的单元格。 如果没有冻结窗格，则此方法返回一个 对象，其 |
| toJSON() | 重写 JavaScript |
| unfreeze() | 移除工作表中的所有冻结窗格。 |
属性详细信息
context
方法详细信息
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();
});