Share via

Excel.WorksheetFreezePanes class

  • リファレンス
パッケージ:
excel
Extends
OfficeExtension.ClientObject

注釈

[ API セット: ExcelApi 1.7 ]

プロパティ

context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

メソッド

freezeAt(frozenRange)

アクティブなワークシート ビューに固定セルを設定します。 指定された範囲は、上部と左端のウィンドウで固定されるセルに対応します。
freezeColumns(count)

ワークシートの最初の列または列を固定します。
freezeRows(count)

ワークシートの一番上の行を固定します。
getLocation()

アクティブなワークシート ビュー内の固定セルを記述する範囲を取得します。 固定範囲は、上部と左端のウィンドウで固定されているセルに対応します。
getLocationOrNullObject()

アクティブなワークシート ビュー内の固定セルを記述する範囲を取得します。 固定範囲は、上部と左端のウィンドウで固定されているセルに対応します。 固定ウィンドウがない場合、このメソッドは プロパティが に設定されたオブジェクトをisNullObjecttrue返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
toJSON()

API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを 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

固定する列の数 (省略可能)、すべての列を固定解除する場合は 0

戻り値

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

固定する行数 (省略可能)、すべての行を固定解除するには 0

戻り値

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

API オブジェクトが に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドを 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();
});