Excel.WorksheetFreezePanes class
- Extends
注釈
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
メソッド
| freeze |
アクティブなワークシート ビューに固定セルを設定します。 指定された範囲は、上部と左端のウィンドウで固定されるセルに対応します。 |
| freeze |
ワークシートの最初の列または列を固定します。 |
| freeze |
ワークシートの一番上の行を固定します。 |
| get |
アクティブなワークシート ビュー内の固定セルを記述する範囲を取得します。 固定範囲は、上部と左端のウィンドウで固定されているセルに対応します。 |
| get |
アクティブなワークシート ビュー内の固定セルを記述する範囲を取得します。 固定範囲は、上部と左端のウィンドウで固定されているセルに対応します。 固定ウィンドウがない場合、このメソッドは |
| toJSON() | API オブジェクトが |
| 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
固定する列の数 (省略可能)、すべての列を固定解除する場合は 0
戻り値
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
固定する行数 (省略可能)、すべての行を固定解除するには 0
戻り値
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()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (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();
});
Office Add-ins