Excel.Worksheet class

Une feuille de calcul Excel est une grille de cellules. Il peut contenir des données, des tableaux, des graphiques, etc. Pour en savoir plus sur le modèle objet de feuille de calcul, lisez Work with worksheets using the Excel JavaScript API.

Extends

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

Propriétés

autoFilter

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

charts

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

comments

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

context

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

customProperties

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

enableCalculation

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

freezePanes

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

horizontalPageBreaks

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

id

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.

name

Nom complet de la feuille de calcul.

namedSheetViews

Renvoie une collection d’affichages de feuille présents dans la feuille de calcul.

names

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

pageLayout

Obtient PageLayout l’objet de la feuille de calcul.

pivotTables

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

position

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

protection

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

shapes

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

showGridlines

Spécifie si le quadrillage est visible par l’utilisateur.

showHeadings

Spécifie si les titres sont visibles pour l’utilisateur.

slicers

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

standardHeight

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

standardWidth

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.

tabColor

Couleur de l’onglet de la feuille de calcul. Lors de la récupération de la couleur de l’onglet, si la feuille de calcul est invisible, la valeur sera null. Si la feuille de calcul est visible mais que la couleur de l’onglet est définie sur auto, une chaîne vide est renvoyée. Dans le cas contraire, 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 couleur réelle dans le cas contraire.

tabId

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

tables

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

tasks

Renvoie une collection de tâches présentes dans la feuille de calcul.

verticalPageBreaks

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

visibility

Visibilité de la feuille de calcul.

Méthodes

activate()

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

calculate(markAllDirty)

Calcule toutes les cellules d’une feuille de calcul.

copy(positionType, relativeTo)

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

copy(positionTypeString, relativeTo)

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

delete()

Supprime la feuille de calcul du classeur. Notez que si la visibilité de la feuille de calcul est définie sur « VeryHidden », l’opération de suppression échoue avec une InvalidOperation exception. Vous devez d’abord modifier sa visibilité pour qu’elle soit masquée ou visible avant de la supprimer.

findAll(text, criteria)

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, comprenant une ou RangeAreas plusieurs plages rectangulaires.

findAllOrNullObject(text, criteria)

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, comprenant une ou RangeAreas plusieurs plages rectangulaires.

getCell(row, column)

Obtient Range l’objet 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.

getNext(visibleOnly)

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

getNextOrNullObject(visibleOnly)

Obtient la feuille de calcul qui suit celle-ci. Si aucune feuille de calcul ne suit celle-ci, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getPrevious(visibleOnly)

Obtient la feuille de calcul qui précède celle-ci. Si aucune feuille de calcul ne précède celle-ci, cette méthode génère une erreur.

getPreviousOrNullObject(visibleOnly)

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 isNullObject la propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getRange(address)

Obtient Range l’objet, qui représente un seul bloc rectangulaire de cellules, spécifié par l’adresse ou le nom.

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Obtient l’objet qui commence à un index de ligne et un index de colonne particuliers et s’étend sur un certain nombre de lignes Range et de colonnes.

getRanges(address)

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

getUsedRange(valuesOnly)

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 retourne la cellule supérieure gauche (c’est-à-dire qu’elle ne lance pas d’erreur).

getUsedRangeOrNullObject(valuesOnly)

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 dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

load(options)

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)

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)

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.

replaceAll(text, replacement, criteria)

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

set(properties, options)

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

set(properties)

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

showOutlineLevels(rowLevels, columnLevels)

Affiche les groupes de lignes ou de colonnes par niveaux de plan. Décrit les groupes et récapitule une liste de données dans la feuille de calcul. Les rowLevels columnLevels paramètres spécifient le nombre de niveaux du plan qui seront affichés. La plage d’arguments acceptable est 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.

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 Worksheet est un objet API, la toJSON méthode renvoie un objet JavaScript simple (tapé sous la formeExcel.Interfaces.WorksheetData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Événements

onActivated

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

onCalculated

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

onChanged

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

onColumnSorted

Se produit lorsqu’une ou plusieurs colonnes ont été triées. Cela se produit à la suite d’une opération de tri de gauche à droite.

onDeactivated

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

onFiltered

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

onFormatChanged

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

onFormulaChanged

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

onNameChanged

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

onProtectionChanged

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

onRowHiddenChanged

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

onRowSorted

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.

onSelectionChanged

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

onSingleClicked

Se produit lorsqu’une action clic gauche/clic se produit dans la feuille de calcul. Cet événement ne sera pas déclenché lorsque vous cliquerez dans les cas suivants :

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

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

onVisibilityChanged

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

Détails de la propriété

autoFilter

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

readonly autoFilter: Excel.AutoFilter;

Valeur de propriété

Remarques

[Ensemble 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
await Excel.run(async (context) => {
    // This method adds a percentage AutoFilter to the active worksheet 
    // and applies the filter to a column of the used range.

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

charts

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

readonly charts: Excel.ChartCollection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

comments

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

readonly comments: Excel.CommentCollection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

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é

customProperties

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

[Ensemble 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}`);
  });
});

enableCalculation

Détermine si Excel devez recalculer la feuille de calcul si nécessaire. True si Excel recalcul de 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é

boolean

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

freezePanes

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

readonly freezePanes: Excel.WorksheetFreezePanes;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

horizontalPageBreaks

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

[Ensemble d’API : ExcelApi 1.9 ]

id

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é

string

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

name

Nom complet de la feuille de calcul.

name: string;

Valeur de propriété

string

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

namedSheetViews

Renvoie une collection d’affichages de feuille présents dans la feuille de calcul.

readonly namedSheetViews: Excel.NamedSheetViewCollection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]

names

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

readonly names: Excel.NamedItemCollection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.4 ]

pageLayout

Obtient PageLayout l’objet de la feuille de calcul.

readonly pageLayout: Excel.PageLayout;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

pivotTables

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

readonly pivotTables: Excel.PivotTableCollection;

Valeur de propriété

Remarques

[Ensemble 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

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

position: number;

Valeur de propriété

number

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

Exemples

// Set worksheet position. 
Excel.run(function (ctx) { 
    var wSheetName = 'Sheet1';
    var worksheet = ctx.workbook.worksheets.getItem(wSheetName);
    worksheet.position = 2;
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

protection

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

readonly protection: Excel.WorksheetProtection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.2 ]

Exemples

Excel.run(function(ctx) {
  // get a reference to Sheet1
  var sheet = ctx.workbook.worksheets.getItem("Sheet1");

  // Protect inserting or deleting rows in Sheet1
  sheet.protection.protect({
    allowInsertRows: false,
    allowDeleteRows: false
  });

  return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// 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.
Excel.run(function(ctx) {
  var sheet = ctx.workbook.worksheets.getItem("Sheet1");
  sheet.protection.protect({
    allowInsertRows: false, // Protect row insertion
    allowDeleteRows: true // Unprotect row deletion
  });
});

shapes

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

readonly shapes: Excel.ShapeCollection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

showGridlines

Spécifie si le quadrillage est visible par l’utilisateur.

showGridlines: boolean;

Valeur de propriété

boolean

Remarques

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

showHeadings

Spécifie si les titres sont visibles pour l’utilisateur.

showHeadings: boolean;

Valeur de propriété

boolean

Remarques

[Ensemble d’API : ExcelApi 1.8 ]

slicers

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

readonly slicers: Excel.SlicerCollection;

Valeur de propriété

Remarques

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

standardHeight

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é

number

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

standardWidth

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é

number

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

tabColor

Couleur de l’onglet de la feuille de calcul. Lors de la récupération de la couleur de l’onglet, si la feuille de calcul est invisible, la valeur sera null. Si la feuille de calcul est visible mais que la couleur de l’onglet est définie sur auto, une chaîne vide est renvoyée. Dans le cas contraire, 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 couleur réelle dans le cas contraire.

tabColor: string;

Valeur de propriété

string

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/tab-color.yaml
await Excel.run(async (context) => {
    const activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.tabColor = "#FF0000";

    await context.sync();
});

tabId

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

readonly tabId: number;

Valeur de propriété

number

Remarques

[Ensemble d’API : ExcelApi 1.14 ]

tables

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

readonly tables: Excel.TableCollection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

tasks

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Renvoie une collection de tâches présentes dans la feuille de calcul.

readonly tasks: Excel.DocumentTaskCollection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

verticalPageBreaks

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

[Ensemble d’API : ExcelApi 1.9 ]

visibility

Visibilité de la feuille de calcul.

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

Valeur de propriété

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

Remarques

[Ensemble d’API : ExcelApi 1.1 pour la visibilité de lecture ; 1,2 pour le définir. ]

Détails de la méthode

activate()

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

activate(): void;

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

Exemples

Excel.run(function (ctx) { 
    var wSheetName = 'Sheet1';
    var worksheet = ctx.workbook.worksheets.getItem(wSheetName);
    worksheet.activate();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

calculate(markAllDirty)

Calcule toutes les cellules d’une feuille de calcul.

calculate(markAllDirty: boolean): void;

Paramètres

markAllDirty

boolean

True, pour marquer tout comme étant sale.

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.6 ]

copy(positionType, relativeTo)

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

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

Paramètres

positionType
Excel.WorksheetPositionType

Emplacement dans le manuel où placer la feuille de calcul nouvellement créée. La valeur par défaut est « None », qui insère la feuille de calcul au début de la feuille de calcul.

relativeTo
Excel.Worksheet

Feuille de calcul existante qui détermine la position de la feuille de calcul nouvellement créée. Cette demande est nécessaire uniquement positionType si la demande est « Before » (avant) ou « After » (après).

Retours

Feuille de calcul nouvellement créée.

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-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 + "'")
});

copy(positionTypeString, relativeTo)

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

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

Paramètres

positionTypeString

"None" | "Before" | "After" | "Beginning" | "End"

Emplacement dans le manuel où placer la feuille de calcul nouvellement créée. La valeur par défaut est « None », qui insère la feuille de calcul au début de la feuille de calcul.

relativeTo
Excel.Worksheet

Feuille de calcul existante qui détermine la position de la feuille de calcul nouvellement créée. Cette demande est nécessaire uniquement positionType si la demande est « Before » (avant) ou « After » (après).

Retours

Feuille de calcul nouvellement créée.

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

delete()

Supprime la feuille de calcul du classeur. Notez que si la visibilité de la feuille de calcul est définie sur « VeryHidden », l’opération de suppression échoue avec une InvalidOperation exception. Vous devez d’abord modifier sa visibilité pour qu’elle soit masquée ou visible avant de la supprimer.

delete(): void;

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

Exemples

Excel.run(function (ctx) { 
    var wSheetName = 'Sheet1';
    var worksheet = ctx.workbook.worksheets.getItem(wSheetName);
    worksheet.delete();
    return ctx.sync(); 
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

findAll(text, criteria)

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, comprenant une ou RangeAreas plusieurs plages rectangulaires.

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

Paramètres

text

string

Chaîne à rechercher.

criteria
Excel.WorksheetSearchCriteria

Critères de recherche supplémentaires, notamment si la recherche doit correspondre à la cellule entière ou être sensible à la cas.

Retours

Objet, RangeAreas comprenant une ou plusieurs plages rectangulaires, qui correspond aux critères de recherche. Si aucune cellule ne répond à ce critère, une erreur ItemNotFound est lancée.

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

findAllOrNullObject(text, criteria)

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, comprenant une ou RangeAreas plusieurs plages rectangulaires.

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

Paramètres

text

string

Chaîne à rechercher.

criteria
Excel.WorksheetSearchCriteria

Critères de recherche supplémentaires, notamment si la recherche doit correspondre à la cellule entière ou être sensible à la cas.

Retours

Objet, RangeAreas comprenant une ou plusieurs plages rectangulaires, qui correspond aux critères de recherche. S’il n’existe aucune correspondance, cette méthode renvoie un objet dont isNullObject la propriété est définie sur true. Pour plus d’informations, * voir méthodes et propriétés OrNullObject.

Remarques

[Ensemble 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"
    }
});

getCell(row, column)

Obtient Range l’objet 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

row

number

Numéro de ligne de la cellule à récupérer. Avec indice zéro.

column

number

Numéro de colonne de la cellule à récupérer. Avec indice zéro.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

Exemples

Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var cell = worksheet.getCell(0,0);
    cell.load('address');
    return ctx.sync().then(function() {
        console.log(cell.address);
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getNext(visibleOnly)

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

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

Paramètres

visibleOnly

boolean

Facultatif. If true, ne considère que les feuilles de calcul visibles, en ignorer les feuilles masquées.

Retours

Remarques

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

getNextOrNullObject(visibleOnly)

Obtient la feuille de calcul qui suit celle-ci. Si aucune feuille de calcul ne suit celle-ci, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

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

Paramètres

visibleOnly

boolean

Facultatif. If true, ne considère que les feuilles de calcul visibles, en ignorer les feuilles masquées.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.5 ]

getPrevious(visibleOnly)

Obtient la feuille de calcul qui précède celle-ci. Si aucune feuille de calcul ne précède celle-ci, cette méthode génère une erreur.

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

Paramètres

visibleOnly

boolean

Facultatif. If true, ne considère que les feuilles de calcul visibles, en ignorer les feuilles masquées.

Retours

Remarques

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

getPreviousOrNullObject(visibleOnly)

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 isNullObject la propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

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

Paramètres

visibleOnly

boolean

Facultatif. If true, ne considère que les feuilles de calcul visibles, en ignorer les feuilles masquées.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.5 ]

getRange(address)

Obtient Range l’objet, qui représente un seul bloc rectangulaire de cellules, spécifié par l’adresse ou le nom.

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

Paramètres

address

string

Facultatif. Chaîne représentant l’adresse ou le nom de la plage. Par exemple, « A1:B2 ». Si cette propriété n’est pas définie, la plage de la feuille de calcul toute entière est renvoyée.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

Exemples

// Below example uses range address to get the range object.
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeAddress = "A1:F8";
    var worksheet = ctx.workbook.worksheets.getItem(sheetName);
    var range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    return ctx.sync().then(function() {
        console.log(range.cellCount);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});
// Below example uses a named-range to get the range object.
Excel.run(function (ctx) { 
    var sheetName = "Sheet1";
    var rangeName = 'MyRange';
    var range = ctx.workbook.worksheets.getItem(sheetName).getRange(rangeName);
    range.load('address');
    return ctx.sync().then(function() {
        console.log(range.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Obtient l’objet qui commence à un index de ligne et un index de colonne particuliers et s’étend sur un certain nombre de lignes Range et de colonnes.

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

Paramètres

startRow

number

Ligne de début (indexé zéro).

startColumn

number

Colonne de début (indexé zéro).

rowCount

number

Nombre de lignes à inclure dans la plage.

columnCount

number

Nombre de colonnes à inclure dans la plage.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

getRanges(address)

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

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

Paramètres

address

string

Facultatif. Chaîne contenant les noms ou les adresses séparées par des virgules ou séparées par des points-virgules des plages individuelles. Par exemple, « A1:B2, A5:B5 » ou « A1:B2 ; A5:B5 ». S’il n’est pas RangeAreas spécifié, un objet de la feuille de calcul entière est renvoyé.

Retours

Remarques

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

getUsedRange(valuesOnly)

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 retourne la cellule supérieure gauche (c’est-à-dire qu’elle ne lance pas d’erreur).

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

Paramètres

valuesOnly

boolean

Facultatif. If true, ne tient compte que des cellules avec des valeurs en tant que cellules utilisées (en ignorant la mise en forme). [Ensemble d’api : ExcelApi 1.2]

Retours

Remarques

[Ensemble d’API : ExcelApi 1.1 ]

Exemples

Excel.run(function (ctx) { 
    var wSheetName = 'Sheet1';
    var worksheet = ctx.workbook.worksheets.getItem(wSheetName);
    var usedRange = worksheet.getUsedRange();
    usedRange.load('address');
    return ctx.sync().then(function() {
            console.log(usedRange.address);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

getUsedRangeOrNullObject(valuesOnly)

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 dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

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

Paramètres

valuesOnly

boolean

Facultatif. Prend uniquement en compte les cellules avec des valeurs sous forme de cellules utilisées.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.4 ]

load(options)

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

options
Excel.Interfaces.WorksheetLoadOptions

Fournit des options pour lesquelles les propriétés de l’objet à charger.

Retours

load(propertyNames)

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

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

Exemples

// Get worksheet properties based on sheet name.
Excel.run(function (ctx) { 
    var wSheetName = 'Sheet1';
    var worksheet = ctx.workbook.worksheets.getItem(wSheetName);
    worksheet.load('position')
    return ctx.sync().then(function() {
            console.log(worksheet.position);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

replaceAll(text, replacement, criteria)

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

text

string

Chaîne à rechercher.

replacement

string

Chaîne qui remplace la chaîne d’origine.

criteria
Excel.ReplaceCriteria

Critères de remplacement supplémentaires.

Retours

Nombre de remplacements effectués.

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

set(properties, options)

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

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

Paramètres

properties
Excel.Interfaces.WorksheetUpdateData

Objet JavaScript avec des propriétés structurées de manière isomorphe aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option pour supprimer les erreurs si l’objet propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

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

set(properties: Excel.Worksheet): void;

Paramètres

properties
Excel.Worksheet

Retours

void

showOutlineLevels(rowLevels, columnLevels)

Affiche les groupes de lignes ou de colonnes par niveaux de plan. Décrit les groupes et récapitule une liste de données dans la feuille de calcul. Les rowLevels columnLevels paramètres spécifient le nombre de niveaux du plan qui seront affichés. La plage d’arguments acceptable est 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

rowLevels

number

Nombre de niveaux de ligne d’un plan à afficher.

columnLevels

number

Nombre de niveaux de colonne d’un plan à afficher.

Retours

void

Remarques

[Ensemble 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 collapses the entire outline.
    sheet.showOutlineLevels(1, 1);
    await context.sync();
});
// 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();
});

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 Worksheet est un objet API, la toJSON méthode renvoie un objet JavaScript simple (tapé sous la formeExcel.Interfaces.WorksheetData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.WorksheetData;

Retours

Détails de l'événement

onActivated

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

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

Type d'événement

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

Exemples

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

onCalculated

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

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

Type d'événement

Remarques

[Ensemble d’API : ExcelApi 1.8 ]

Exemples

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

onChanged

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

[Ensemble 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.");
});

onColumnSorted

Se produit lorsqu’une ou plusieurs colonnes ont été triées. Cela se produit à la suite d’une opération de tri de gauche à droite.

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

Type d'événement

Remarques

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

onDeactivated

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

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

Type d'événement

Remarques

[Ensemble d’API : ExcelApi 1.7 ]

Exemples

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

onFiltered

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

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

Type d'événement

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

onFormatChanged

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

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

Type d'événement

Remarques

[Ensemble d’API : ExcelApi 1.9 ]

onFormulaChanged

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

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

Type d'événement

Remarques

[Ensemble 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.");
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-formula-changed.yaml
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}.`
    );
  });
}

onNameChanged

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

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

Type d'événement

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]

onProtectionChanged

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

[Ensemble 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
await Excel.run(async (context) => {
    // This method registers an event handler for the onProtectionChanged event of a worksheet.

    // 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.");
});
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml
async function checkProtection(event: Excel.WorksheetProtectionChangedEventArgs) {
    await Excel.run(async (context) => {
        // This method is an event handler that returns the protection status of a worksheet and information about the changed worksheet.
        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 + ".");
    });
}

onRowHiddenChanged

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

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

Type d'événement

Remarques

[Ensemble d’API : ExcelApi 1.11 ]

Exemples

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

onRowSorted

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

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

onSelectionChanged

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

[Ensemble d’API : ExcelApi 1.7 ]

Exemples

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

onSingleClicked

Se produit lorsqu’une action clic gauche/clic se produit dans la feuille de calcul. Cet événement ne sera pas déclenché lorsque vous cliquerez dans les cas suivants :

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

  • L’utilisateur sélectionne une cellule dans le mode lorsque des 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

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

onVisibilityChanged

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

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

Type d'événement

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]