Excel.WorksheetFreezePanes class

Extends

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

Propriétés

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

Méthodes

freezeAt(frozenRange)

Définit les cellules figées dans l’affichage de la feuille de calcul active. La plage fournie correspond aux cellules figées dans les volets supérieur et gauche.

freezeColumns(count)

Figer la première ou les premières colonnes de la feuille de calcul en place.

freezeRows(count)

Figer la ou les lignes du haut de la feuille de calcul en place.

getLocation()

Obtient une plage qui définit les cellules figées dans l’affichage de la feuille de calcul active. La plage figée correspond aux cellules figées dans le volet supérieur et le volet le plus à gauche.

getLocationOrNullObject()

Obtient une plage qui définit les cellules figées dans l’affichage de la feuille de calcul active. La plage figée correspond aux cellules figées dans le volet supérieur et le volet le plus à gauche. S’il n’existe pas de volet figé, cette méthode renvoie un objet dont isNullObject la propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Tandis que la Excel. L’objet WorksheetFreezePanes est un objet API, la méthode renvoie un toJSON objet JavaScript simple (tapé sous la formeExcel.Interfaces.WorksheetFreezePanesData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

unfreeze()

Supprime tous les volets figés dans la feuille de calcul.

Détails de la propriété

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

context: RequestContext;

Valeur de propriété

Détails de la méthode

freezeAt(frozenRange)

Définit les cellules figées dans l’affichage de la feuille de calcul active. La plage fournie correspond aux cellules figées dans les volets supérieur et gauche.

freezeAt(frozenRange: Range | string): void;

Paramètres

frozenRange

Excel.Range | string

Plage qui représente les cellules à figer ou pour null supprimer tous les volets figés.

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

Exemples

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

Figer la première ou les premières colonnes de la feuille de calcul en place.

freezeColumns(count?: number): void;

Paramètres

count

number

Nombre facultatif de colonnes à figer ou zéro pour libérer toutes les colonnes

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

Exemples

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

Figer la ou les lignes du haut de la feuille de calcul en place.

freezeRows(count?: number): void;

Paramètres

count

number

Nombre facultatif de lignes à figer ou zéro pour libérer toutes les lignes

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

Exemples

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

Obtient une plage qui définit les cellules figées dans l’affichage de la feuille de calcul active. La plage figée correspond aux cellules figées dans le volet supérieur et le volet le plus à gauche.

getLocation(): Excel.Range;

Retours

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

getLocationOrNullObject()

Obtient une plage qui définit les cellules figées dans l’affichage de la feuille de calcul active. La plage figée correspond aux cellules figées dans le volet supérieur et le volet le plus à gauche. S’il n’existe pas de volet figé, cette méthode renvoie un objet dont isNullObject la propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getLocationOrNullObject(): Excel.Range;

Retours

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

Exemples

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

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Tandis que la Excel. L’objet WorksheetFreezePanes est un objet API, la méthode renvoie un toJSON objet JavaScript simple (tapé sous la formeExcel.Interfaces.WorksheetFreezePanesData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

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

Retours

{ [key: string]: string; }

unfreeze()

Supprime tous les volets figés dans la feuille de calcul.

unfreeze(): void;

Retours

void

Remarques

[Ensemble d’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();
});