Excel.Worksheet class

Représente l’objet AutoFilter de la feuille de calcul.

readonly autoFilter: Excel.AutoFilter;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

Renvoie une collection de graphiques faisant partie de la feuille de calcul.

readonly charts: Excel.ChartCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Renvoie une collection de tous les objets Lecteur sur l’ordinateur.

readonly comments: Excel.CommentCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.10

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient une collection de propriétés personnalisées au niveau de la feuille de calcul.

readonly customProperties: Excel.WorksheetCustomPropertyCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.12

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml

await Excel.run(async (context) => {
  // Load the keys and values of all custom properties in the current worksheet.
  const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
  customWorksheetProperties.load(["key", "value"]);
  await context.sync();

  // Log each custom property to the console.
  // Note that your document may have more properties than those you have set using this snippet.
  customWorksheetProperties.items.forEach((property) => {
    console.log(`${property.key}: ${property.value}`);
  });
});

Détermine si Excel doit recalculer la feuille de calcul si nécessaire. True si Excel recalcule la feuille de calcul si nécessaire. Elle a la valeur False si Excel ne recalcule pas la feuille.

enableCalculation: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Obtient un objet qui peut être utilisé pour manipuler les volets figés de la feuille de calcul.

readonly freezePanes: Excel.WorksheetFreezePanes;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Obtient la collection de saut de page horizontal pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.

readonly horizontalPageBreaks: Excel.PageBreakCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Renvoie une valeur qui permet d’identifier la feuille de calcul de façon unique dans un classeur donné. La valeur de l’identificateur reste identique, même lorsque la feuille de calcul est renommée ou déplacée.

readonly id: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Nom complet de la feuille de calcul. Le nom doit comporter moins de 32 caractères.

name: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Renvoie un ensemble de feuilles personnelles présentes dans la feuille de calcul.

readonly namedSheetViews: Excel.NamedSheetViewCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApiOnline 1.1

Collection de noms inclus dans l’étendue de la feuille de calcul active.

readonly names: Excel.NamedItemCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.4

Renvoie une collection de tous les objets de notes de la feuille de calcul.

readonly notes: Excel.NoteCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.18

Récupère l’objet PageLayout de la feuille de calcul.

readonly pageLayout: Excel.PageLayout;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Collection de tableaux croisés dynamiques qui font partie de la feuille de calcul.

readonly pivotTables: Excel.PivotTableCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.3

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  // Get the names of all the PivotTables in the current worksheet.
  const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables;
  pivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current worksheet:")
  pivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

Position de la feuille de calcul au sein du classeur (sur une base zéro).

position: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Set worksheet position.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.position = 2;
    await context.sync(); 
});

Renvoie l’objet de protection de feuille pour une feuille de calcul.

readonly protection: Excel.WorksheetProtection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

Exemples

// Unprotecting a worksheet with unprotect() will remove all 
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the 
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sheet1");
  sheet.protection.protect({
    allowInsertRows: false, // Protect row insertion
    allowDeleteRows: true // Unprotect row deletion
  });
});

Renvoie une collection de tous les objets Forme sur la feuille de calcul.

readonly shapes: Excel.ShapeCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Indique si les icônes des types de données sont visibles dans la feuille de calcul. Par défaut, les icônes des types de données sont visibles.

showDataTypeIcons: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.19

Indique si le quadrillage est visible par l’utilisateur.

showGridlines: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.8

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/gridlines.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.showGridlines = true;

    await context.sync();
});

Indique si les titres sont visibles par l’utilisateur.

showHeadings: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.8

Renvoie une collection de segments qui font partie de la feuille de calcul.

readonly slicers: Excel.SlicerCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Pivot");
    const slicer = sheet.slicers.add(
        "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
        "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
    );
    slicer.name = "Fruit Slicer";
    await context.sync();
});

Renvoie la hauteur standard (par défaut) de toutes les lignes dans la feuille de calcul, en points.

readonly standardHeight: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Spécifie la largeur standard (par défaut) de toutes les colonnes de la feuille de calcul. Une unité de largeur de colonne est égale à la largeur d'un caractère du style Normal. Dans le cas des polices proportionnelles, la largeur du caractère 0 (zéro) est utilisée.

standardWidth: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Couleur de l’onglet de la feuille de calcul. Lors de la récupération de la couleur de tabulation, si la feuille de calcul est invisible, la valeur sera null. Si la feuille de calcul est visible mais que la couleur de tabulation est définie sur automatique, une chaîne vide est renvoyée. Sinon, la propriété sera définie sur une couleur, sous la forme #RRGGBB (par exemple, « FFA500 »). Lorsque vous définissez la couleur, utilisez une chaîne vide pour définir une couleur « automatique », ou une vraie couleur dans le cas contraire.

tabColor: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/tab-color.yaml

await Excel.run(async (context) => {
    const activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.tabColor = "#FF0000";

    await context.sync();
});

Renvoie une valeur représentant cette feuille de calcul qui peut être lue par Open Office XML. Il s’agit d’une valeur entière, qui est différente de worksheet.id (qui renvoie un identificateur global unique) et worksheet.name (qui renvoie une valeur telle que « Feuil1 »).

readonly tabId: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.14

Collection de tableaux qui font partie de la feuille de calcul.

readonly tables: Excel.TableCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Renvoie un ensemble de tâches présentes dans la feuille de calcul.

readonly tasks: Excel.DocumentTaskCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

Obtient la collection de saut de page vertical pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.

readonly verticalPageBreaks: Excel.PageBreakCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Visibilité de la feuille de calcul.

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1 pour la visibilité de la lecture ; 1.2 pour le régler.

Active la feuille de calcul dans l’interface utilisateur Excel.

activate(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.activate();
    await context.sync(); 
});

Calcule toutes les cellules d’une feuille de calcul.

calculate(markAllDirty: boolean): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.6

Vérifie l’orthographe des mots dans cette feuille de calcul. Cette méthode ouvre la boîte de dialogue Orthographe dans l’interface utilisateur d’Excel.

checkSpelling(options?: Excel.CheckSpellingOptions): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApiDesktop 1.1

Cette méthode efface les flèches d'audit de la feuille de calcul.

clearArrows(): void;

Retours

Remarques

Jeu d’API : ExcelApiDesktop 1.1

Copie une feuille de calcul et la place à la position spécifiée.

copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;

Paramètres

Retours

Feuille de calcul nouvellement créée.

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-copy.yaml

await Excel.run(async (context) => {

    let myWorkbook = context.workbook;
    let sampleSheet = myWorkbook.worksheets.getActiveWorksheet();
    let copiedSheet = sampleSheet.copy("End")

    sampleSheet.load("name");
    copiedSheet.load("name");

    await context.sync();

    console.log("'" + sampleSheet.name + "' was copied to '" + copiedSheet.name + "'")
});

Copie une feuille de calcul et la place à la position spécifiée.

copy(positionType?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;

Paramètres

Retours

Feuille de calcul nouvellement créée.

Remarques

Jeu d’API : ExcelApi 1.7

Supprime la feuille de calcul du classeur. Notez que si la visibilité de la feuille de calcul est définie sur « TrèsMasqué », l’opération de suppression échoue avec une InvalidOperation exception. Vous devez d’abord modifier sa visibilité en masqué ou visible avant de le supprimer.

delete(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.delete();
    await context.sync(); 
});

Renvoie le résultat de l’évaluation d’une chaîne de formule. Seule l’entrée de formule est prise en charge. Si le nom de la formule n’est pas valide, l’erreur InvalidArgument est générée.

evaluate(name: string): OfficeExtension.ClientResult<any>;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApiDesktop 1.1

Recherche toutes les occurrences de la chaîne donnée en fonction des critères spécifiés et les renvoie en tant qu’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires. Le contenu des feuilles de calcul masquées n’est pas renvoyé.

findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Paramètres

Retours

Objet RangeAreas composé d’une ou plusieurs plages rectangulaires répondant aux critères de recherche. Si aucune cellule ne répond à ces critères, une ItemNotFound erreur est générée.

Remarques

Jeu d’API : ExcelApi 1.9

Recherche toutes les occurrences de la chaîne donnée en fonction des critères spécifiés et les renvoie en tant qu’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires. Le contenu des feuilles de calcul masquées n’est pas renvoyé.

findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Paramètres

Retours

Objet RangeAreas composé d’une ou plusieurs plages rectangulaires répondant aux critères de recherche. S’il n’y a pas de correspondance, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-find-all.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const foundRanges = sheet.findAllOrNullObject("Complete", {
        completeMatch: true,
        matchCase: false
    });

    await context.sync();

    if (foundRanges.isNullObject) {
        console.log("No complete projects");
    } else {
        foundRanges.format.fill.color = "green"
    }
});

Récupère l’objet Range contenant la cellule unique en fonction des numéros de ligne et de colonne. La cellule peut se trouver en dehors des limites de sa plage parente, tant qu’elle reste dans la grille de la feuille de calcul.

getCell(row: number, column: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const cell = worksheet.getCell(0,0);
    cell.load('address');
    await context.sync();

    console.log(cell.address);
});

Obtient la feuille de calcul qui suit celle-ci. Si aucune feuille de calcul ne suit celle-ci, cette méthode renvoie une erreur.

getNext(visibleOnly?: boolean): Excel.Worksheet;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.5

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;

    // We don't want to include the default worksheet that was created
    // when the workbook was created, so our "firstSheet" will be the one
    // after the literal first. Note chaining of navigation methods.
    const firstSheet = sheets.getFirst().getNext();
    const lastSheet = sheets.getLast();
    const firstTaxRateRange = firstSheet.getRange("B2");
    const lastTaxRateRange = lastSheet.getRange("B2");

    firstSheet.load("name");
    lastSheet.load("name");
    firstTaxRateRange.load("text");
    lastTaxRateRange.load("text");

    await context.sync();

    let firstYear = firstSheet.name.substr(5, 4);
    let lastYear = lastSheet.name.substr(5, 4);
    console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`)

    await context.sync();
});

Obtient la feuille de calcul qui suit celle-ci. S’il n’y a pas de feuilles de calcul après celle-ci, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.5

Obtient la feuille de calcul qui précède celle-ci. S’il n’existe aucune feuille de calcul précédente, cette méthode renvoie une erreur.

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.5

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;
    const currentSheet = sheets.getActiveWorksheet();
    const previousYearSheet = currentSheet.getPrevious();
    const currentTaxDueRange = currentSheet.getRange("C2");
    const previousTaxDueRange = previousYearSheet.getRange("C2");

    currentSheet.load("name");
    previousYearSheet.load("name");
    currentTaxDueRange.load("text");
    previousTaxDueRange.load("text");

    await context.sync();

    let currentYear = currentSheet.name.substr(5, 4);
    let previousYear = previousYearSheet.name.substr(5, 4);
    console.log("Two Year Tax Due Comparison", `Tax due for ${currentYear} was ${currentTaxDueRange.text[0][0]}\nTax due for ${previousYear} was ${previousTaxDueRange.text[0][0]}`)

    await context.sync();
});

Obtient la feuille de calcul qui précède celle-ci. S’il n’existe aucune feuille de calcul précédente, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.5

Récupère l’objet Range , représentant un seul bloc rectangulaire de cellules, spécifié par l’adresse ou le nom.

getRange(address?: string): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

// Use the range address to get the range object.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    await context.sync();
    
    console.log(range.cellCount);
});

Récupère l’objet Range à partir d’un index de ligne et d’une colonne spécifiques, et s’étend sur un certain nombre de lignes et de colonnes.

getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.7

Obtient l’objet RangeAreas , représentant un ou plusieurs blocs de plages rectangulaires, spécifié par l’adresse ou le nom.

getRanges(address?: string): Excel.RangeAreas;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.9

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const specifiedRanges = sheet.getRanges("D3:D5, G3:G5");
    specifiedRanges.format.fill.color = "pink";

    await context.sync();
})

La plage utilisée est la plus petite plage qui englobe toutes les cellules auxquelles une valeur ou un format est affecté. Si la feuille de calcul entière est vide, cette fonction renvoie la cellule supérieure gauche (c’est-à-dire qu’elle ne renvoie pas d’erreur).

getUsedRange(valuesOnly?: boolean): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.1

Exemples

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    const usedRange = worksheet.getUsedRange();
    usedRange.load('address');
    await context.sync();
    
    console.log(usedRange.address);
});

La plage utilisée est la plus petite plage qui englobe toutes les cellules auxquelles une valeur ou un format est affecté. Si la feuille de calcul entière est vide, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.4

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.Worksheet;

Paramètres

Retours

Exemples

// Get worksheet properties based on sheet name.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.load('position')
    await context.sync();
    
    console.log(worksheet.position);
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Worksheet;

Paramètres

Retours

Détecte et remplace la chaîne donnée basée sur les critères spécifiés dans la plage active.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Paramètres

Retours

Nombre de remplacements effectués.

Remarques

Jeu d’API : ExcelApi 1.9

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Exemples

// Set the color and name of the current worksheet.
await Excel.run(async (context) => {
  const activeSheet = context.workbook.worksheets.getActiveWorksheet();
  activeSheet.set({
    tabColor: "yellow",
    name: "MySheet"
  });

  await context.sync();
});

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Worksheet): void;

Paramètres

Retours

Affiche les groupes de lignes ou de colonnes par leur niveau hiérarchique. Décrit, regroupe et synthétise une liste de données de la feuille de calcul. Les rowLevels paramètres et columnLevels spécifient le nombre de niveaux du plan qui seront affichés. La plage d’arguments acceptable est comprise entre 0 et 8. La valeur 0 ne modifie pas l’affichage actuel. Une valeur supérieure au nombre actuel de niveaux affiche tous les niveaux.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This shows the top 3 outline levels; collapsing any additional sublevels.
    sheet.showOutlineLevels(3, 3);
    await context.sync();
});

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Worksheet est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.WorksheetDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.WorksheetData;

Retours

Se produit lorsque la feuille de calcul est activée.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onActivated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The activated worksheet ID is: " + event.worksheetId);
            await context.sync();
        });
    });
    await context.sync();
});

Se produit lorsque la feuille de calcul est calculée.

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.8

Exemples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onCalculated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The worksheet has recalculated.");
            await context.sync();
        });
    });
    await context.sync();
});

Se produit lorsque les cellules de la feuille de calcul sont calculées de manière asynchrone.

Cet événement est déclenché à la fin d’un cycle de calcul, similaire à l’événement onCalculated . En règle générale, lorsque le calcul est terminé pour une cellule, l’événement onCalculated est déclenché. Toutefois, si le calcul place une valeur temporaire en attente (telle que « #BUSY ! ») dans la cellule, onCalculationBusy il est déclenché à la place pour indiquer que l’état de la cellule a changé, bien que le calcul de la valeur finale ne soit pas encore terminé. Lorsqu’un cycle de calcul ultérieur termine le calcul de cette cellule, l’événement onCalculated est déclenché.

Les fonctionnalités de formule telles que JavaScript, User-Defined Functions et les formules =PY peuvent déclencher cet événement.

readonly onCalculationBusy: OfficeExtension.EventHandlers<Excel.WorksheetCalculationBusyEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

Se produit lorsque des données changent dans une feuille de calcul spécifique.

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onChanged.add(onChange);
    await context.sync();

    console.log("Added a worksheet-level data-changed event handler.");
});

Se produit lorsqu’une ou plusieurs colonnes ont été triées. Cette situation se produit à la suite d’un tri de gauche à droite.

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

await Excel.run(async (context) => {
    console.log("Adding column handler");
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This will fire whenever a column has been moved as the result of a sort action.
    sheet.onColumnSorted.add((event) => {
        return Excel.run((context) => {
            console.log("Column sorted: " + event.address);
            const sheet = context.workbook.worksheets.getActiveWorksheet();

            // Clear formatting for section, then highlight the sorted area.
            sheet.getRange("A1:E5").format.fill.clear();
            if (event.address !== "") {
                sheet.getRanges(event.address).format.fill.color = "yellow";
            }

            return context.sync();
        });
    });
});

Se produit lorsque la feuille de calcul est désactivée.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onDeactivated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The deactivated worksheet is: " + event.worksheetId);
            await context.sync();
        });
    });
    await context.sync();
});

Se produit lorsqu’un filtre est appliqué sur une feuille de calcul spécifique.

readonly onFiltered: OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

Se produit lorsque le filtre est modifié sur un tableau spécifique.

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.9

Se produit lorsqu’une ou plusieurs formules sont modifiées dans cette feuille de calcul. Cet événement concerne la modification de la formule elle-même, et non la valeur de données résultant du calcul de la formule.

L’événement est déclenché uniquement lorsque la cellule contient déjà une formule. La nouvelle valeur de cellule ne peut pas inclure de formule. Cet événement n’est pas déclenché lorsqu’une formule est entrée dans une cellule qui n’en contenait pas auparavant.

readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.13

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-formula-changed.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet named "Sample".
  let sheet = context.workbook.worksheets.getItem("Sample");
  
  // Register the formula changed event handler for this worksheet.
  sheet.onFormulaChanged.add(formulaChangeHandler);
  await context.sync();
  
  console.log("Registered a formula changed event handler for this worksheet.");
});

...

async function formulaChangeHandler(event: Excel.WorksheetFormulaChangedEventArgs) {
  await Excel.run(async (context) => {
    // Retrieve details about the formula change event.
    const cellAddress = event.formulaDetails[0].cellAddress;
    const previousFormula = event.formulaDetails[0].previousFormula;
    const source = event.source;
    
    // Print out the change event details.
    console.log(
      `The formula in cell ${cellAddress} changed. 
      The previous formula was: ${previousFormula}. 
      The source of the change was: ${source}.`
    );
  });
}

Se produit lorsque le nom de la feuille de calcul est modifié.

readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.17

Se produit lorsque l’état de protection de la feuille de calcul est modifié.

readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.14

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml

// This function registers an event handler for the onProtectionChanged event of a worksheet.
await Excel.run(async (context) => {
    // Set "Sample" as the active worksheet.
    context.workbook.worksheets.getItemOrNullObject("Sample").delete();
    const sheet = context.workbook.worksheets.add("Sample");
    sheet.activate();

    // Register the onProtectionChanged event handler.
    sheet.onProtectionChanged.add(checkProtection);
    await context.sync();
    console.log("Added a worksheet protection change event handler.");
});

...

async function checkProtection(event: Excel.WorksheetProtectionChangedEventArgs) {
    // This function is an event handler that returns the protection status of a worksheet
    // and information about the changed worksheet.
    await Excel.run(async (context) => {
        const protectionStatus = event.isProtected;
        const worksheetId = event.worksheetId;
        const source = event.source;
        console.log("Protection status changed. Protection status is now: " + protectionStatus + ".");
        console.log("    ID of changed worksheet: " + worksheetId + ".");
        console.log("    Source of change event: " + source + ".");
    });
}

Se produit lorsque l’état masqué d’une ou de plusieurs lignes a changé dans une feuille de calcul spécifique.

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.11

Exemples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.onRowHiddenChanged.add(function (event) {
        return Excel.run(async (context) => {
            console.log(`Row ${event.address} is now ${event.changeType}`);
            await context.sync();
        });
    });
    await context.sync();
});

Se produit lorsqu’une ou plusieurs lignes ont été triées. Cela se produit en raison d’une opération de tri de haut en bas.

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

await Excel.run(async (context) => {
    console.log("Adding row handler");
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This will fire whenever a row has been moved as the result of a sort action.
    sheet.onRowSorted.add((event) => {
        return Excel.run((context) => {
            console.log("Row sorted: " + event.address);
            const sheet = context.workbook.worksheets.getActiveWorksheet();

            // Clear formatting for section, then highlight the sorted area.
            sheet.getRange("A1:E5").format.fill.clear();
            if (event.address !== "") {
                sheet.getRanges(event.address).format.fill.color = "yellow";
            }

            return context.sync();
        });
    });
});

Se produit lorsque la sélection change dans une feuille de calcul spécifique.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onSelectionChanged.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The selected range has changed to: " + event.address);
            await context.sync();
        });
    });
    await context.sync();
});

Se produit lorsqu’un clic gauche/un appui se produit dans la feuille de calcul. Cet événement n’est pas déclenché lorsque vous cliquez dessus dans les cas suivants :

• L’utilisateur fait glisser la souris pour la sélection multiple.

• L’utilisateur sélectionne une cellule dans le mode lorsque les arguments de cellule sont sélectionnés pour les références de formule.

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-worksheet-single-click.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.onSingleClicked.add((event) => {
        return Excel.run((context) => {
            console.log(`Click detected at ${event.address} (pixel offset from upper-left cell corner: ${event.offsetX}, ${event.offsetY})`);
            return context.sync();
        });
    });

    console.log("The worksheet click handler is registered.");

    await context.sync();
});

Se produit lorsque la visibilité de la feuille de calcul est modifiée.

readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;

Type d’événement

Remarques

Jeu d’API : ExcelApi 1.17